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