core: Fix libdwarf and Qt build failure
[clinton/Virtual-Jaguar-Rx.git] / docs / vj_HistoryNotes.txt
1 Release 5 (TBA)
2 ---------------
3 0) 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
5 1) Added a specific breakpoint for the M68K illegal instruction exception
6 -- Alert box will display a message and then the code will stop
7 2) Added a specific breakpoint for the M68K address error exception
8 -- Alert box will display a message and then the code will stop
9 3) Added a HW registers browser window and set a tab for the Blitter
10 4) Added detection for the unsigned/signed short type
11 -- Will allow the return of a short type variable's value
12 5) Added a specific breakpoint for the M68K Unimplemented instruction, and Exception not referenced exceptions
13 6) Fix potential emulator freeze after an exception has occured
14 7) Fix a random crash when reading the source lines information
15 8) Added ELF & DWARF .debug* types
16 9) Added ELF section types check and new error messages
17 10) Modified the call stack layout window and added source filename from the called source line
18 11) Added a source tab in the main window for step into tracing
19 12) Added the step over for source level tracing
20 13) Set text conversion to Qt/HTML format for the M68K tracing window
21 14) Added a source code file date check when reading DWARF information
22 -- Will avoid source code mismatching with the ELF executable
23 15) Remove Visual Studio 2015 support
24 16) Work around fix for a compilation error on Linux
25 -- EEPROM directory creation allowed only for Windows at the moment
26 17) Show the SR value as a readable form in the M68K CPU browser
27 18) Potential fix to compile on Linux
28 -- Added the relative directory path for the Qt include files
29 19) Merge the Linux build fixes from @richard42
30 -- Jaguar core's makefile and Qt pro file updates, fix filenames case sensitive & fixes for Linux
31 20) 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
34 21) Project has switched to libdwarf 20210305 library 64bits for VS 2017
35 22) Breakpoint list window is now refreshed after a new breakpoint is set
36 23) Handle number of M68K cycles used when tracing in debugger mode
37 -- The cycles are displayed in the emulator status window
38 24) Improve the DWARF source line number reporting
39 25) Added a #line in the call stack window
40 26) Added video output display in a specific window
41 27) Fixed potential crash with the debugger tabs reset
42 28) Added a search feature in the All Watch variables window
43 29) Support the structure's members in the Local variables window
44 30) Code refactoring for the variables support in debugger mode
45 31) Support the structure and union members from the DWARF information
46 32) Added a Virtual Jaguar Rx logo in the About window
47 33) Fix compilation / link error for MSYS2 / MinGW64
48 34) Documentation updates
50 Release 4a (15th August 2019)
51 -----------------------------
52 Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
53 -
54 0) Fix specific breakpoint for ROM cartridge or unknown memory location writing
56 Release 4 (10th August 2019)
57 ----------------------------
58 Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
59 -
60 0) The zoom value setting has been fixed in the registry
61 1) Debugger mode now shares the same alpine rom path setting
62 2) Local variables window displays register name now
63 3) Switch to Zlib 1.2.11 static library 64bits for VS 2017
64 4) Switch to SDL 1.2.15 static library 64bits for VS 2017
65 5) Local variables window displays values from function's parameters
66 6) Fixed the typedef's name display in Local and Watch variables window
67 7) 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
70 8) Local variables window detects now if a variable is used or not by the code
71 9) The address provided in the debugger memory windows is now verified to prevent crash
72 -- Wrong address will be displayed in red
73 10) 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
81 11) Added some log information for the emulator initialisations
82 12) Breakpoint will happen in case of writing at unknown memory location
83 -- Alert box will display a message and then the code will stop
84 13) Added the DRAM size in the emulator status window
85 14) Debugger sources code clean-up
86 15) Added a call stack feature
87 16) Follow platform requirement to prevent source file reading issue
88 17) 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
93 18) 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
95 19) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
96 20) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
97 21) Added a Jaguar model and BIOS configuration tab
98 22) Jaguar model and BIOS configuration integration
99 23) Added LEB128 decoding functions
100 -- It is used for the DWARF decoding information
101 24) Debugger support improvement
102 -- DWARF support for the enum type (partial), structure and subroutine type
103 -- Debugger can report variable's unsigned char value
104 25) 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
110 26) Added screenshot feature
111 -- Not accessible in debugger mode
112 -- Added screenshot editable path in the general tab, and a key binding
113 27) Minor misspellings fixes
114 28) DWARF source code directory path clean-up
115 29) Added a source code files list viewer
116 -- List comes from the DWARF information
117 30) 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
119 31) Added a sorting filter in the all watches window
120 32) Improve source code file reading to avoid additional text/bytes reading
121 33) Help & content texts updates
122 34) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
123 35) 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
125 36) Added the Rx version's contact in the help text
126 37) Added search paths in case of missing DWARF directories information
127 -- Used to look for the file(s)
128 38) 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
130 39) Added function name support from ELF structure
131 40) Added the return address information in the call stack
132 41) Added multiple breakpoints feature, and their key bindings, for functions only
133 42) Added timer initialisation for the SDL setup
134 43) Added a cartridge view menu
135 -- Added a window to display my own directory and his files list
136 44) Debugger sources code clean-up
137 45) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
138 46) Fix crash with potential missing DWARF structure tag's type name
139 47) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
140 48) Project has switched to Qt 5.12.0 library 64bits for VS 2017
141 49) Added a Save Dump As... feature to save a memory zone to a file
142 50) 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
144 51) Removed the sorting filter in the all watches window
145 52) Fix the support of the DRAM size limit option in the heap allocation window
146 53) Set cartridge view menu for debugger mode only
147 54) Prevent crash in case of call stack is out of range
149 Release 3 (13th November 2017)
150 ------------------------------
151 Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
152 -
153 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
154 1) Added an Exception Vector Table window
155 2) Modified the About window to update the credits list in a more appropriate way
156 -- Updated the emulator application credits line
157 3) Added 'Rx' word to the emulator name
158 4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
159 5) Added ui, alpine and debugger groups in the settings
160 6) Added the possibility to erase settings
161 7) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
162 8) 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)
165 9) Fixed a crash, in Release mode, when the HW labels setting is turn on
166 10) Solved an interference between the HW labels setting and the one used by the debugger
167 -- The setting is now only the reference used
168 11) Fixed the SP (Stack) browser UI potential missing data
169 12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
170 13) 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
172 14) 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
174 15) Improved the .heap section detection to avoid a detection error
175 -- Depend vlink version, .heap section may have an Alloc flag
176 16) Fixed a crash when DWARF information does references to missing source code files
177 17) Added a local variables window
178 18) Project has switched to Visual Studio 2017 and Qt 5.9.1 library
180 Release 2 (3rd September 2017)
181 ------------------------------
182 0) Added some error detections when reading the ELF executable file
183 1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
184 2) "Step Over" code function for BSR/JSR functions
185 3) Added the .debug_ranges detection to avoid a detection error
186 4) DWARF support
187 -- TAG: Compilation Unit, Subprogram, Variables, Types
188 -- Line numbers, symbols, functions
189 5) Added an All Watch window for non-local variables
190 6) Added a heap allocator window based on my own memory allocation functions
191 7) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
192 8) Windows refreshing executed only if windows is visible
193 9) Added a restart function
194 -- Restart only the 68000 program counter to his original set
195 10) Modified the icons color backgound for the "Step In" and "Step Over" functions
196 11) Updated the About window to update the credits list
197 12) 64 bits Release executable
198 13) Fixed (hacking) the display of the SP (Stack) browser
199 14) 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
201 15) Added some information in the --help/-h/-? option
202 16) --debugger option no longer force the log file
203 17) Added a --dram-max option to extend the DRAM size to 8MB
204 18) Added the "enter" key support when setting the BPM (Breapoint)
205 19) Save the windows positions, size and visibilities (show or hide) status
206 -- Such windows will automatically respawn in the next emulator launch
208 Release 1 (12th February 2017)
209 ------------------------------
210 0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
211 1) Clean-up the tracing / no-tracing flags for better U.I understanding
212 2) Added SP (Stack) browser
213 3) User can change now the number of lines of disassembly displayed in the tracing window
214 4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
215 5) Added an emulator status window (GPU status, M68K debugger and tracking status)
216 6) Added a GPU disassembly tracing window - Display the current PC pointer
217 7) Added a DSP disassembly tracing window - Display the current PC pointer
218 8) Added possibility to change refresh rate of browsers when emulation is launched
219 9) 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
221 10) Minor U.I cosmetic changes
222 11) 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
225 Release 0 (5th January 2017)
226 ----------------------------
227 0) New option --debugger
228 1) ELF format support
229 2) ELF debug symbol support
230 3) "Step Into" code function
231 4) Menus layout dedicated to the debugger
232 5) Added a dedicated main window for tracing (M68K)
233 6) Added a Debugger tab in the config tab
234 7) Visual Studio 2015 project support
235 8) libelf-0.8.13 library support
236 9) 64 bits debug executable only
239 Known issues
240 ============
241 1) 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
242 2) 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
245 3) DWARF 2 support
246 -- With GCC: the code must be compiled with the -gdwarf-2 option
247 4) 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
250 5) The 2MB mirroring is no longer applied in case of --dram-max option usage
251 6) 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
253 7) The Exception Vector Table window displays only 65 vectors
254 -- Missing vectors may be added in future release
255 8) 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
257 9) 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
260 10) 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
261 11) Emulator will crash in case of wrong address value provided in the memory browser
262 12) The RAM access log is limited to the 2MB
263 13) 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
265 14) Source code disply only assembled code from vasm with option -dwarf
266 15) 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
268 16) Some ASCII characters may be not displayed correctly
269 -- Probably depend how the text is displayed, this is related to the Qt/HTML encoding done when reading DWARF file
270 17) Potential legacy crash when leaving emulator in pause mode for a long period of time
271 -- Need much investigation
273 Cosmetic / UX issues
274 ====================
275 1) The SP (Stack) icon color backgound doesn't look similar with the other ones
276 2) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
277 3) Not every features have associated key bindings
279 Legacy issues/hints
280 ===================
281 1) 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
284 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
286 Project information
287 ===================
288 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
289 2) Visual Studio 2017 project support for 64 bits
290 3) libelf 0.8.13 library 64bits for VS 2017
291 4) libdwarf 20210305 library 64bits for VS 2017
292 5) Qt 5.12.0 library 64bits for VS 2017
293 6) Zlib 1.2.11 library 64bits for VS 2017
294 7) SDL 1.2.15 library 64bits for VS 2017
295 8) The original make files have been modified to follow the requirements and modifications
296 9) The 'Rx' word has been added to the emulator name to make distinction with the official version
297 10) The project is set at
298 11) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
299 -- Text / License terms are the same
300 14) The x86 configuration has been removed in the VS 2017 project
303 Download statistics
304 -------------------
305 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
306 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
307 No downloads statistics available for the Release 2
308 No downloads statistics available for the Release 3