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