Merge branch 'feature/sourcetracing' into develop
[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) Project has switched to libdwarf 20191104 library 64bits for VS 2017
18 11) Modified the call stack layout window and added source filename from the called source line
20 Release 4a (15th August 2019)
21 -----------------------------
22 Git commit: f04df4f185ed4f3cfc805d0f61b3c019a108ae2c
23 -
24 0) Fix specific breakpoint for ROM cartridge or unknown memory location writing
26 Release 4 (10th August 2019)
27 ----------------------------
28 Git commit: 9b25d85d1ea4a9476b83476bcec65e05464f68da
29 -
30 0) The zoom value setting has been fixed in the registry
31 1) Debugger mode now shares the same alpine rom path setting
32 2) Local variables window displays register name now
33 3) Switch to Zlib 1.2.11 static library 64bits for VS 2017
34 4) Switch to SDL 1.2.15 static library 64bits for VS 2017
35 5) Local variables window displays values from function's parameters
36 6) Fixed the typedef's name display in Local and Watch variables window
37 7) Breakpoint may now occur in case of a ROM cartridge writing
38 -- ROM cartridge writing detection follow the alpine "allow writes to cartridge rom"'s flag check
39 -- 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
40 8) Local variables window detects now if a variable is used or not by the code
41 9) The address provided in the debugger memory windows is now verified to prevent crash
42 -- Wrong address will be displayed in red
43 10) UI changes
44 -- Added new icons for the exit and status features
45 -- Modified icons for the SP (Stack) browser
46 -- Unified icons sizes depend on their usage (drop down menu and main menu)
47 -- Underline the active M68K line in the disassembly window
48 -- Allow the up/down navigation on the SP (Stack) browser
49 -- Restart function cleans-up the SP (Stack) browser and the heap allocator system
50 -- Fixed the up navigation on the memory window
51 11) Added some log information for the emulator initialisations
52 12) Breakpoint will happen in case of writing at unknown memory location
53 -- Alert box will display a message and then the code will stop
54 13) Added the DRAM size in the emulator status window
55 14) Debugger sources code clean-up
56 15) Added a call stack feature
57 16) Follow platform requirement to prevent source file reading issue
58 17) UI modifications
59 -- Modified icon for the memory window to make a distinction with the memory browser
60 -- The all watch, and Exception Vector Table windows, can be closed using keyboard
61 -- Renamed the debugger dedicated icons to make a distinction
62 -- Added the call stack window
63 18) Fixed a crash in the all watch window after loading a new binary without ELF/DWARF information
64 -- Previously used ELF/DWARF information was still accessible
65 19) Fixed slash/backslash issue, in the Alpine tab, to follow platform requirement
66 20) Heap allocation window uses the DRAM size limit option and detect if heap allocation shares space with SP (Stack)
67 21) Added a Jaguar model and BIOS configuration tab
68 22) Jaguar model and BIOS configuration integration
69 23) Added LEB128 decoding functions
70 -- It is used for the DWARF decoding information
71 24) Debugger support improvement
72 -- DWARF support for the enum type (partial), structure and subroutine type
73 -- Debugger can report variable's unsigned char value
74 25) UI modifications
75 -- Added a status bar, better status report & information display for the heap allocation window
76 -- Added a status bar, better status report & information display for the local variables window
77 -- Added better information display for the exception vectors table window, and added some missing vectors
78 -- Added a status bar, better status report & information display for the call stack window
79 -- Added a status bar, better status report & information display for the all watches window
80 26) Added screenshot feature
81 -- Not accessible in debugger mode
82 -- Added screenshot editable path in the general tab, and a key binding
83 27) Minor misspellings fixes
84 28) DWARF source code directory path clean-up
85 29) Added a source code files list viewer
86 -- List comes from the DWARF information
87 30) Check potential variables missing/incomplete description found in the DWARF information
88 -- No crash involved but can help to reduce such as variables duplicate or the blank ones
89 31) Added a sorting filter in the all watches window
90 32) Improve source code file reading to avoid additional text/bytes reading
91 33) Help & content texts updates
92 34) Fixed a crash legacy issue when emulator launches in Alpine mode without a valid rom
93 35) Added the support for the used lines source's DWARF structure
94 -- Mostly used to handle missing subprogram's lines information, and missing CU's low/high PC
95 36) Added the Rx version's contact in the help text
96 37) Added search paths in case of missing DWARF directories information
97 -- Used to look for the file(s)
98 38) Setup CU's low/high PC in case of the DWARF structures doesn't have it
99 -- Used mostly to allow display the source assembled with vasm
100 39) Added function name support from ELF structure
101 40) Added the return address information in the call stack
102 41) Added multiple breakpoints feature, and their key bindings, for functions only
103 42) Added timer initialisation for the SDL setup
104 43) Added a cartridge view menu
105 -- Added a window to display my own directory and his files list
106 44) Debugger sources code clean-up
107 45) Fix a crash when emulator, in non-debugger mode, opens the breakpoint UIs at launch
108 46) Fix crash with potential missing DWARF structure tag's type name
109 47) Added ELF sections check so a potential unknown section will stop, or not stop, the decoding
110 48) Project has switched to QT 5.12.0 library 64bits for VS 2017
111 49) Added a Save Dump As... feature to save a memory zone to a file
112 50) The -d command line option, dedicated to the debugger, has been renamed to avoid duplication with the dsp one
113 -- -d has been renamed by -D because another -d was also used for the dsp command line option
114 51) Removed the sorting filter in the all watches window
115 52) Fix the support of the DRAM size limit option in the heap allocation window
116 53) Set cartridge view menu for debugger mode only
117 54) Prevent crash in case of call stack is out of range
119 Release 3 (13th November 2017)
120 ------------------------------
121 Git commit: b1b673a3b0d19e3c2c45b6590b773b11e45bced7
122 -
123 0) Fixed the windows respawning in the next emulator launch within --alpine or --debugger options
124 1) Added an Exception Vector Table window
125 2) Modified the About window to update the credits list in a more appropriate way
126 -- Updated the emulator application credits line
127 3) Added 'Rx' word to the emulator name
128 4) Fixed a crash when reading the DWARF information in the case of the DWARF2 format has not been used
129 5) Added ui, alpine and debugger groups in the settings
130 6) Added the possibility to erase settings
131 7) Added the --es-all, --es-ui, --es-alpine and --es-debugger options to erase specific settings
132 8) Added a key bindings tab and adapted the configuration dialog tabs
133 -- User can modify the key bindings where appropriate
134 -- Key bindings UI is displayed based on the option used (--debugger, -- alpine)
135 9) Fixed a crash, in Release mode, when the HW labels setting is turn on
136 10) Solved an interference between the HW labels setting and the one used by the debugger
137 -- The setting is now only the reference used
138 11) Fixed the SP (Stack) browser UI potential missing data
139 12) Create a directory for EEPROMs (based on the EEPROMs setting) if it doesn't already exist
140 13) Keep the scrollbar position in accordance of the M68K PC pointer
141 -- UI displays the source without the need to move down/up the scrollbar
142 14) Fixed a crash when DWARF information report a source line number exceeding the number of lines present in a source file
143 -- This may come from the linker vlink
144 15) Improved the .heap section detection to avoid a detection error
145 -- Depend vlink version, .heap section may have an Alloc flag
146 16) Fixed a crash when DWARF information does references to missing source code files
147 17) Added a local variables window
148 18) Project has switched to Visual Studio 2017 and QT 5.9.1 library
150 Release 2 (3rd September 2017)
151 ------------------------------
152 0) Added some error detections when reading the ELF executable file
153 1) Added all hardware labels (based on the document scans from the Version 2.4 - June 7, 1995)
154 2) "Step Over" code function for BSR/JSR functions
155 3) Added the .debug_ranges detection to avoid a detection error
156 4) DWARF support
157 -- TAG: Compilation Unit, Subprogram, Variables, Types
158 -- Line numbers, symbols, functions
159 5) Added an All Watch window for non-local variables
160 6) Added a heap allocator window based on my own memory allocation functions
161 7) Added additional 4 memory windows with address input based on hexa, decimal or symbol name
162 8) Windows refreshing executed only if windows is visible
163 9) Added a restart function
164 -- Restart only the 68000 program counter to his original set
165 10) Modified the icons color backgound for the "Step In" and "Step Over" functions
166 11) Updated the About window to update the credits list
167 12) 64 bits Release executable
168 13) Fixed (hacking) the display of the SP (Stack) browser
169 14) Set the emulator in Halt mode when launched in alpine debug mode without a loaded rom
170 -- Otherwise the 68000 program counter will have a 0 value and will execute the code at this address
171 15) Added some information in the --help/-h/-? option
172 16) --debugger option no longer force the log file
173 17) Added a --dram-max option to extend the DRAM size to 8MB
174 18) Added the "enter" key support when setting the BPM (Breapoint)
175 19) Save the windows positions, size and visibilities (show or hide) status
176 -- Such windows will automatically respawn in the next emulator launch
178 Release 1 (12th February 2017)
179 ------------------------------
180 0) BPM (Breapoint) now stop at the designated address and no longer stop after executing the code
181 1) Clean-up the tracing / no-tracing flags for better U.I understanding
182 2) Added SP (Stack) browser
183 3) User can change now the number of lines of disassembly displayed in the tracing window
184 4) User can turn on/off the op-codes associated in the disassembly lines displayed in the M68K tracing window
185 5) Added an emulator status window (GPU status, M68K debugger and tracking status)
186 6) Added a GPU disassembly tracing window - Display the current PC pointer
187 7) Added a DSP disassembly tracing window - Display the current PC pointer
188 8) Added possibility to change refresh rate of browsers when emulation is launched
189 9) Display partial hardware labels (Internal Memory and Graphics sub-system address space) in the disassembly lines displayed in the M68K tracing window
190 -- Display first the hardware labels (based from the Jag V8 dev. PDF) and then the ones possibly found in the ELF debug symbol
191 10) Minor U.I cosmetic changes
192 11) User can turn on/off the hardware labels associated in the disassembly lines displayed in the M68K tracing window
193 -- It doesn't apply to the hardware labels possibly found in the ELF debug symbol
195 Release 0 (5th January 2017)
196 ----------------------------
197 0) New option --debugger
198 1) ELF format support
199 2) ELF debug symbol support
200 3) "Step Into" code function
201 4) Menus layout dedicated to the debugger
202 5) Added a dedicated main window for tracing (M68K)
203 6) Added a Debugger tab in the config tab
204 7) Visual Studio 2015 project support
205 8) libelf-0.8.13 library support
206 9) 64 bits debug executable only
209 Known issues
210 ============
211 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
212 2) The BPM (Breapoint) remains stuck on his address when user wants to continue the code execution
213 -- Need to trace over the BPM or unset the BPM
214 -- The issue can be prevented if the code doesn't set IRQ, otherwise the IRQ will need to be traced to get back control
215 3) DWARF 2 support
216 -- With GCC: the code must be compiled with the -gdwarf-2 option
217 4) The Local and Watch variables window may display not available type information or empty information
218 -- Such missing information may be included in future release
219 -- The 'const' type may not be reported correctly in the DWARF information
220 5) The 2MB mirroring is no longer applied in case of --dram-max option usage
221 6) Stack must reflect the --dram-max option usage otherwise the stack may be corrupted
222 -- The application needs to set the SP (Stack) in accordance
223 7) The Exception Vector Table window displays only 65 vectors
224 -- Missing vectors may be added in future release
225 8) User needs to manualy check if the Atari Jaguar executable match his source code files
226 -- Otherwise, source code and assembly may not match or leads to instabilities
227 9) The emulator needs to be restarted in case of the following actions occur
228 -- Key bindings changes
229 -- BIOS selection changes and without new executable load
230 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
231 11) Emulator will crash in case of wrong address value provided in the memory browser
232 12) The RAM access log is limited to the 2MB
233 13) In various occasions, global variables may be duplicated or without name in the DWARF information
234 -- It may come from the Vlink linker and/or GCC 7.1.0 or 8.2.0 compilation with -gdwarf-2 option
235 14) Source code disply only assembled code from vasm with option -dwarf
236 15) After a new breakpoint set, the breakpoint list window is not refreshed
237 -- User must perform an operation, such code tracing, to see the breakpoints list update
238 16) Some ASCII characters may be not displayed correctly
239 -- It depend how the text is displayed, this is related to the QT/HTML encoding done when reading DWARF file
240 17) Potential legacy crash when leaving emulator in pause mode for a long period of time
242 Cosmetic / UX issues
243 ====================
244 1) The SP (Stack) icon color backgound doesn't look similar with the other ones
245 2) The SP (Stack) browser size always open at a forced size no matter if the size has been changed
246 3) Not every features have associated key bindings
248 Legacy issues/hints
249 ===================
250 1) Emulator seems to have easter egg(s)
251 -- The option --yarrr displays a single message and end the application
252 -- Pressing F8, while in the main window, will create an extra message in the log file
253 2) The --alpine option force the log file but it can be override if --no-log option is set after the --alpine option
255 Project information
256 ===================
257 1) Code based on the Shamus Hammons source code available via Gethub by the 12th September 2017 (2.1.3 Final)
258 2) Visual Studio 2015/2017 project support for 64 bits
259 3) libelf 0.8.13 library 64bits for VS 2015/2017
260 4) libdwarf 20191104 library 64bits for VS 2017
261 5) QT 5.5.1 library 64bits for VS 2015
262 6) QT 5.12.0 library 64bits for VS 2017
263 7) Zlib 1.2.8 library 64bits for VS 2015
264 8) Zlib 1.2.11 library 64bits for VS 2017
265 9) SDL 1.2.15 library 64bits for VS 2015/2017
266 10) The original make files have been modified to follow the requirements and modifications
267 11) The 'Rx' word has been added to the emulator name to make distinction with the official version
268 12) The project is set at
269 13) GPLv3 file document has been renamed as LICENSE, to fit better the GitHub requirements
270 -- Text / License terms are the same
271 14) The x86 configuration has been removed in the VS 2017 project
274 Download statistics
275 -------------------
276 jaguar64eu : 15 downloads for the Release 0 on the 12th Feb, 2017
277 jaguar64eu : 18 downloads for the Release 1 on the 21st May, 2017
278 No downloads statistics available for the Release 2
279 No downloads statistics available for the Release 3