1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
|
/*
* debug.c - Various debugging options.
*
* Written by
* Andreas Boose <viceteam@t-online.de>
*
* This file is part of VICE, the Versatile Commodore Emulator.
* See README for copyright notice.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA.
*
*/
#include "vice.h"
#include <stdio.h>
#include <string.h>
#include "archdep.h"
#include "cmdline.h"
#include "debug.h"
#include "drive.h"
#include "event.h"
#include "interrupt.h"
#include "lib.h"
#include "log.h"
#include "resources.h"
#include "translate.h"
#include "types.h"
#include "ui.h"
#include "util.h"
debug_t debug;
#ifdef DEBUG
inline static void debug_history_step(const char *st);
#endif
static int set_do_core_dumps(int val, void *param)
{
debug.do_core_dumps = val;
return 0;
}
#ifdef DEBUG
static int debug_autoplay_frames;
static int set_maincpu_traceflg(int val, void *param)
{
debug.maincpu_traceflg = val;
return 0;
}
static int set_drive_traceflg(int val, void *param)
{
debug.drivecpu_traceflg[(int)param] = val;
return 0;
}
static int set_trace_mode(int val, void *param)
{
debug.trace_mode = val;
return 0;
}
static int set_autoplay_frames(int val, void *param)
{
debug_autoplay_frames = val;
return 0;
}
#endif
/* Debug-related resources. */
static const resource_int_t resources_int[] = {
{ "DoCoreDump", 0, RES_EVENT_NO, NULL,
&debug.do_core_dumps, set_do_core_dumps, NULL },
#ifdef DEBUG
{ "MainCPU_TRACE", 0, RES_EVENT_NO, NULL,
&debug.maincpu_traceflg, set_maincpu_traceflg, NULL },
{ "Drive0CPU_TRACE", 0, RES_EVENT_NO, NULL,
&debug.drivecpu_traceflg[0], set_drive_traceflg, (void *)0 },
{ "Drive1CPU_TRACE", 0, RES_EVENT_NO, NULL,
&debug.drivecpu_traceflg[1], set_drive_traceflg, (void *)1 },
#if DRIVE_NUM > 2
{ "Drive2CPU_TRACE", 0, RES_EVENT_NO, NULL,
&debug.drivecpu_traceflg[2], set_drive_traceflg, (void *)2 },
#endif
#if DRIVE_NUM > 3
{ "Drive3CPU_TRACE", 0, RES_EVENT_NO, NULL,
&debug.drivecpu_traceflg[3], set_drive_traceflg, (void *)3 },
#endif
{ "TraceMode", 0, RES_EVENT_NO, NULL,
&debug.trace_mode, set_trace_mode, NULL },
{ "AutoPlaybackFrames", 200, RES_EVENT_NO, NULL,
&debug_autoplay_frames, set_autoplay_frames, NULL },
#endif
{ NULL }
};
int debug_resources_init(void)
{
return resources_register_int(resources_int);
}
static const cmdline_option_t cmdline_options[] = {
#ifdef DEBUG
{ "-trace_maincpu", SET_RESOURCE, 0,
NULL, NULL, "MainCPU_TRACE", (resource_value_t)1,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_TRACE_MAIN_CPU,
NULL, NULL },
{ "+trace_maincpu", SET_RESOURCE, 0,
NULL, NULL, "MainCPU_TRACE", (resource_value_t)0,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_DONT_TRACE_MAIN_CPU,
NULL, NULL },
{ "-trace_drive0", SET_RESOURCE, 0,
NULL, NULL, "Drive0CPU_TRACE", (resource_value_t)1,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_TRACE_DRIVE0_CPU,
NULL, NULL },
{ "+trace_drive0", SET_RESOURCE, 0,
NULL, NULL, "Drive0CPU_TRACE", (resource_value_t)0,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_DONT_TRACE_DRIVE0_CPU,
NULL, NULL },
{ "-trace_drive1", SET_RESOURCE, 0,
NULL, NULL, "Drive1CPU_TRACE", (resource_value_t)1,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_TRACE_DRIVE1_CPU,
NULL, NULL },
{ "+trace_drive1", SET_RESOURCE, 0,
NULL, NULL, "Drive1CPU_TRACE", (resource_value_t)0,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_DONT_TRACE_DRIVE1_CPU,
NULL, NULL },
#if DRIVE_NUM > 2
{ "-trace_drive2", SET_RESOURCE, 0,
NULL, NULL, "Drive2CPU_TRACE", (resource_value_t)1,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_TRACE_DRIVE2_CPU,
NULL, NULL },
{ "+trace_drive2", SET_RESOURCE, 0,
NULL, NULL, "Drive2CPU_TRACE", (resource_value_t)0,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_DONT_TRACE_DRIVE2_CPU,
NULL, NULL },
#endif
#if DRIVE_NUM > 3
{ "-trace_drive3", SET_RESOURCE, 0,
NULL, NULL, "Drive3CPU_TRACE", (resource_value_t)1,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_TRACE_DRIVE3_CPU,
NULL, NULL },
{ "+trace_drive3", SET_RESOURCE, 0,
NULL, NULL, "Drive3CPU_TRACE", (resource_value_t)0,
USE_PARAM_STRING, USE_DESCRIPTION_ID,
IDCLS_UNUSED, IDCLS_DONT_TRACE_DRIVE3_CPU,
NULL, NULL },
#endif
{ "-trace_mode", SET_RESOURCE, 1,
NULL, NULL, "TraceMode", NULL,
USE_PARAM_ID, USE_DESCRIPTION_ID,
IDCLS_P_VALUE, IDCLS_TRACE_MODE,
NULL, NULL },
#endif
{ NULL }
};
int debug_cmdline_options_init(void)
{
return cmdline_register_options(cmdline_options);
}
static unsigned int cycles_per_line;
static unsigned int screen_lines;
void debug_set_machine_parameter(unsigned int cycles, unsigned int lines)
{
cycles_per_line = cycles;
screen_lines = lines;
}
#ifdef DEBUG
#define RLINE(clk) ((unsigned int)((clk) / cycles_per_line % screen_lines))
#define RCYCLE(clk) ((unsigned int)((clk) % cycles_per_line))
void debug_maincpu(DWORD reg_pc, CLOCK mclk, const char *dis, BYTE reg_a,
BYTE reg_x, BYTE reg_y, BYTE reg_sp)
{
switch (debug.trace_mode) {
case DEBUG_SMALL:
{
char small_dis[7];
small_dis[0] = dis[0];
small_dis[1] = dis[1];
if (dis[3] == ' ') {
small_dis[2] = '\0';
} else {
small_dis[2] = dis[3];
small_dis[3] = dis[4];
if (dis[6] == ' ') {
small_dis[4] = '\0';
} else {
small_dis[4] = dis[6];
small_dis[5] = dis[7];
small_dis[6] = '\0';
}
}
log_debug("%04X %ld %02X%02X%02X %s", (unsigned int)reg_pc,
(long)mclk, reg_a, reg_x, reg_y, small_dis);
break;
}
case DEBUG_HISTORY:
case DEBUG_AUTOPLAY:
{
char st[DEBUG_MAXLINELEN];
sprintf(st, ".%04X %02X %02X %8lX %-20s "
"%02X%02X%02X%02X", (unsigned int)reg_pc,
RLINE(mclk), RCYCLE(mclk), (long)mclk, dis,
reg_a, reg_x, reg_y, reg_sp);
debug_history_step(st);
break;
}
case DEBUG_NORMAL:
log_debug(".%04X %03i %03i %10ld %-20s "
"A=$%02X X=$%02X Y=$%02X SP=$%02X", (unsigned int)reg_pc,
RLINE(mclk), RCYCLE(mclk), (long)mclk, dis,
reg_a, reg_x, reg_y, reg_sp);
break;
default:
log_debug("Unknown debug format.");
}
}
void debug_drive(DWORD reg_pc, CLOCK mclk, const char *dis,
BYTE reg_a, BYTE reg_x, BYTE reg_y, BYTE reg_sp)
{
char st[DEBUG_MAXLINELEN];
sprintf(st, "Drive: .%04X %10ld %-20s %02x%02x%02x%02x",
(unsigned int)reg_pc, (long)mclk, dis, reg_a, reg_x, reg_y, reg_sp);
if (debug.trace_mode == DEBUG_HISTORY || debug.trace_mode == DEBUG_AUTOPLAY)
debug_history_step(st);
else
log_debug(st);
}
void debug_text(const char *text)
{
if (debug.trace_mode == DEBUG_HISTORY || debug.trace_mode == DEBUG_AUTOPLAY)
debug_history_step(text);
else
log_debug(text);
}
static void debug_int(interrupt_cpu_status_t *cs, const char *name,
unsigned int type, CLOCK iclk)
{
unsigned int i;
char *textout, *texttmp;
textout = lib_stralloc(name);
for (i = 0; i < cs->num_ints; i++) {
if (cs->pending_int[i] & type) {
texttmp = util_concat(textout, " ", cs->int_name[i], NULL);
lib_free(textout);
textout = texttmp;
}
}
texttmp = lib_msprintf("%s %ld", textout, iclk);
lib_free(textout);
textout = texttmp;
if (debug.trace_mode == DEBUG_HISTORY || debug.trace_mode == DEBUG_AUTOPLAY)
debug_history_step(textout);
else
log_debug(textout);
lib_free(textout);
}
void debug_irq(interrupt_cpu_status_t *cs, CLOCK iclk)
{
debug_int(cs, "*** IRQ", IK_IRQ, iclk);
}
void debug_nmi(interrupt_cpu_status_t *cs, CLOCK iclk)
{
debug_int(cs, "*** NMI", IK_NMI, iclk);
}
void debug_dma(const char *txt, CLOCK dclk, int num)
{
log_debug("*** DMA %s %10ld %02i", txt, (long)dclk, num);
}
/*------------------------------------------------------------------------*/
static FILE *debug_file = NULL;
static char *debug_buffer;
static int debug_buffer_ptr;
static int debug_buffer_size;
static int debug_file_current;
static int debug_file_line;
static int debug_file_milestone;
static int debug_autoplay_nextmode;
static int debug_autoplay_current_frame;
static void debug_close_file(void)
{
if (debug_file != NULL) {
fwrite(debug_buffer, sizeof(char), debug_buffer_ptr, debug_file);
fclose(debug_file);
debug_file = NULL;
debug_buffer_ptr = 0;
debug_file_current++;
}
}
static void debug_create_new_file(void)
{
char *filename, *st;
const char *directory;
debug_close_file();
resources_get_string("EventSnapshotDir", &directory);
st = lib_msprintf("debug%06d", debug_file_current);
filename = util_concat(directory, st, FSDEV_EXT_SEP_STR, "log", NULL);
lib_free(st);
debug_file = fopen(filename, MODE_WRITE_TEXT);
lib_free(filename);
}
static void debug_open_new_file(void)
{
char *filename, *st;
const char *directory;
if (debug_file != NULL)
fclose(debug_file);
resources_get_string("EventSnapshotDir", &directory);
st = lib_msprintf("debug%06d", debug_file_current);
filename = util_concat(directory, st, FSDEV_EXT_SEP_STR, "log", NULL);
lib_free(st);
debug_file = fopen(filename, MODE_READ_TEXT);
if (debug_file != NULL) {
debug_buffer_size = fread(debug_buffer, sizeof(char),
DEBUG_HISTORY_MAXFILESIZE, debug_file);
debug_buffer_ptr = 0;
debug_file_current++;
} else {
debug_buffer_size = 0;
}
debug_file_line = 0;
lib_free(filename);
}
#ifdef DEBUG
inline static void debug_history_step(const char *st)
{
if (event_record_active()) {
if (debug_buffer_ptr + DEBUG_MAXLINELEN >= DEBUG_HISTORY_MAXFILESIZE) {
debug_create_new_file();
}
debug_buffer_ptr +=
sprintf(debug_buffer + debug_buffer_ptr, "%s\n", st);
}
if (event_playback_active()) {
char tempstr[DEBUG_MAXLINELEN];
int line_len = sprintf(tempstr, "%s\n", st);
if (debug_buffer_ptr >= debug_buffer_size)
debug_open_new_file();
debug_file_line++;
if (strncmp(st, debug_buffer + debug_buffer_ptr, strlen(st)) != 0) {
event_playback_stop();
ui_error(translate_text(IDGS_PLAYBACK_ERROR_DIFFERENT)
, st, debug_file_line, debug_file_current - 1);
}
debug_buffer_ptr += line_len;
}
}
#endif
void debug_start_recording(void)
{
if (debug.trace_mode < DEBUG_HISTORY)
return;
debug_autoplay_current_frame = 0;
debug_file_current = 0;
debug_file_milestone = 0;
debug_buffer_ptr = 0;
debug_buffer = lib_malloc(DEBUG_HISTORY_MAXFILESIZE);
debug_create_new_file();
}
void debug_stop_recording(void)
{
if (debug.trace_mode < DEBUG_HISTORY)
return;
debug_close_file();
lib_free(debug_buffer);
}
void debug_start_playback(void)
{
if (debug.trace_mode < DEBUG_HISTORY)
return;
debug_file_current = 0;
debug_file_milestone = 0;
debug_buffer_ptr = 0;
debug_buffer = lib_malloc(DEBUG_HISTORY_MAXFILESIZE);
debug_open_new_file();
}
void debug_stop_playback(void)
{
if (debug.trace_mode < DEBUG_HISTORY)
return;
if (debug_file != NULL) {
fclose(debug_file);
debug_file = NULL;
}
lib_free(debug_buffer);
if (debug.trace_mode == DEBUG_AUTOPLAY)
debug_autoplay_nextmode = 1; /* start recording next */
}
void debug_set_milestone(void)
{
if (debug.trace_mode < DEBUG_HISTORY)
return;
debug_create_new_file();
debug_file_milestone = debug_file_current;
}
void debug_reset_milestone(void)
{
if (debug.trace_mode < DEBUG_HISTORY)
return;
debug_file_current = debug_file_milestone - 1;
debug_create_new_file();
}
void debug_check_autoplay_mode(void)
{
if (debug.trace_mode != DEBUG_AUTOPLAY)
return;
if (debug_autoplay_nextmode == 2)
{
event_playback_start();
debug_autoplay_nextmode = 0;
return;
}
if (debug_autoplay_nextmode == 1) {
/* AUTPLAY mode needs to start recording */
event_record_start();
debug_autoplay_nextmode = 0;
return;
}
debug_autoplay_current_frame++;
if (debug_autoplay_current_frame >= debug_autoplay_frames)
{
debug_autoplay_current_frame = 0;
if (event_record_active())
{
event_record_stop();
debug_autoplay_nextmode = 2; /* start playback next */
return;
}
}
}
#endif
|