summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/debug/dvwpoints.c
blob: 19a5ad1a4d6c83b439c5594cd3d75cfd25fcb298 (plain) (blame)
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
531
532
533
534
535
536
537
538
539
540
/*********************************************************************

    dvwpoints.c

    Watchpoint debugger view.

****************************************************************************

    Copyright Aaron Giles
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are
    met:

        * Redistributions of source code must retain the above copyright
          notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright
          notice, this list of conditions and the following disclaimer in
          the documentation and/or other materials provided with the
          distribution.
        * Neither the name 'MAME' nor the names of its contributors may be
          used to endorse or promote products derived from this software
          without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY AARON GILES ''AS IS'' AND ANY EXPRESS OR
    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL AARON GILES BE LIABLE FOR ANY DIRECT,
    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

***************************************************************************/

#include "emu.h"
#include "dvwpoints.h"



//**************************************************************************
//  DEBUG VIEW WATCH POINTS
//**************************************************************************

static const int tableBreaks[] = { 5, 9, 31, 42, 60, 67, 86, 100 };

//-------------------------------------------------
//  debug_view_watchpoints - constructor
//-------------------------------------------------

debug_view_watchpoints::debug_view_watchpoints(running_machine &machine, debug_view_osd_update_func osdupdate, void *osdprivate)
	: debug_view(machine, DVT_WATCH_POINTS, osdupdate, osdprivate),
		m_sortType(SORT_INDEX_ASCENDING)
{
	// fail if no available sources
	enumerate_sources();
	if (m_source_list.count() == 0)
		throw std::bad_alloc();

	// configure the view
	m_total.y = 10;
	m_supports_cursor = false;
}


//-------------------------------------------------
//  ~debug_view_watchpoints - destructor
//-------------------------------------------------

debug_view_watchpoints::~debug_view_watchpoints()
{
}


//-------------------------------------------------
//  enumerate_sources - enumerate all possible
//  sources for a disassembly view
//-------------------------------------------------

void debug_view_watchpoints::enumerate_sources()
{
	// start with an empty list
	m_source_list.reset();

	// iterate over devices with disassembly interfaces
	disasm_interface_iterator iter(machine().root_device());
	for (device_disasm_interface *dasm = iter.first(); dasm != NULL; dasm = iter.next())
	{
		astring name;
		name.printf("%s '%s'", dasm->device().name(), dasm->device().tag());
		m_source_list.append(*auto_alloc(machine(), debug_view_source(name.cstr(), &dasm->device())));
	}

	// reset the source to a known good entry
	set_source(*m_source_list.head());
}


//-------------------------------------------------
//  view_notify - handle notification of updates
//  to cursor changes
//-------------------------------------------------

void debug_view_watchpoints::view_notify(debug_view_notification type)
{
}


//-------------------------------------------------
//  view_char - handle a character typed within
//  the current view
//-------------------------------------------------

void debug_view_watchpoints::view_char(int chval)
{
}


//-------------------------------------------------
//  view_click - handle a mouse click within the
//  current view
//-------------------------------------------------

void debug_view_watchpoints::view_click(const int button, const debug_view_xy& pos)
{
	bool clickedTopRow = (m_topleft.y == pos.y);

	if (clickedTopRow)
	{
		if (pos.x < tableBreaks[0] && m_sortType == SORT_INDEX_ASCENDING)
			m_sortType = SORT_INDEX_DESCENDING;
		else if (pos.x < tableBreaks[0])
			m_sortType = SORT_INDEX_ASCENDING;
		else if (pos.x < tableBreaks[1] && m_sortType == SORT_ENABLED_ASCENDING)
			m_sortType = SORT_ENABLED_DESCENDING;
		else if (pos.x < tableBreaks[1])
			m_sortType = SORT_ENABLED_ASCENDING;
		else if (pos.x < tableBreaks[2] && m_sortType == SORT_CPU_ASCENDING)
			m_sortType = SORT_CPU_DESCENDING;
		else if (pos.x < tableBreaks[2])
			m_sortType = SORT_CPU_ASCENDING;
		else if (pos.x < tableBreaks[3] && m_sortType == SORT_SPACE_ASCENDING)
			m_sortType = SORT_SPACE_DESCENDING;
		else if (pos.x < tableBreaks[3])
			m_sortType = SORT_SPACE_ASCENDING;
		else if (pos.x < tableBreaks[4] && m_sortType == SORT_ADDRESS_ASCENDING)
			m_sortType = SORT_ADDRESS_DESCENDING;
		else if (pos.x < tableBreaks[4])
			m_sortType = SORT_ADDRESS_ASCENDING;
		else if (pos.x < tableBreaks[5] && m_sortType == SORT_TYPE_ASCENDING)
			m_sortType = SORT_TYPE_DESCENDING;
		else if (pos.x < tableBreaks[5])
			m_sortType = SORT_TYPE_ASCENDING;
		else if (pos.x < tableBreaks[6] && m_sortType == SORT_CONDITION_ASCENDING)
			m_sortType = SORT_CONDITION_DESCENDING;
		else if (pos.x < tableBreaks[6])
			m_sortType = SORT_CONDITION_ASCENDING;
		else if (pos.x < tableBreaks[7] && m_sortType == SORT_ACTION_ASCENDING)
			m_sortType = SORT_ACTION_DESCENDING;
		else if (pos.x < tableBreaks[7])
			m_sortType = SORT_ACTION_ASCENDING;
	}
	else
	{
		// Gather a sorted list of all the watchpoints for all the CPUs
		device_debug::watchpoint** wpList = NULL;
		const int numWPs = watchpoints(SORT_NONE, wpList);

		const int wpIndex = pos.y-1;
		if (wpIndex > numWPs || wpIndex < 0)
			return;

		// Enable / disable
		if (wpList[wpIndex]->enabled())
			wpList[wpIndex]->setEnabled(false);
		else
			wpList[wpIndex]->setEnabled(true);

		delete[] wpList;
	}

	view_update();
}


void debug_view_watchpoints::pad_astring_to_length(astring& str, int len)
{
	int diff = len - str.len();
	if (diff > 0)
	{
		astring buffer;
		buffer.expand(diff);
		for (int i = 0; i < diff; i++)
			buffer.catprintf(" ");
		str.catprintf("%s", buffer.cstr());
	}
}


// Sorting functors for the qsort function
static int cIndexAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->index() > right->index();
}

static int cIndexDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->index() < right->index();
}

static int cEnabledAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->enabled() < right->enabled();
}

static int cEnabledDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->enabled() > right->enabled();
}

static int cCpuAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->debugInterface()->device().tag(), right->debugInterface()->device().tag());
	return result >= 0;
}

static int cCpuDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->debugInterface()->device().tag(), right->debugInterface()->device().tag());
	return result < 0;
}

static int cSpaceAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->space().name(), right->space().name());
	return result >= 0;
}

static int cSpaceDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->space().name(), right->space().name());
	return result < 0;
}

static int cAddressAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->address() > right->address();
}

static int cAddressDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->address() < right->address();
}

static int cTypeAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->type() > right->type();
}

static int cTypeDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	return left->type() < right->type();
}

static int cConditionAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->condition(), right->condition());
	return result >= 0;
}

static int cConditionDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->condition(), right->condition());
	return result < 0;
}

static int cActionAscending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->action(), right->action());
	return result >= 0;
}

static int cActionDescending(const void* a, const void* b)
{
	const device_debug::watchpoint* left = *(device_debug::watchpoint**)a;
	const device_debug::watchpoint* right = *(device_debug::watchpoint**)b;
	const int result = strcmp(left->action(), right->action());
	return result < 0;
}


int debug_view_watchpoints::watchpoints(SortMode sort, device_debug::watchpoint**& wpList)
{
	// Alloc
	int numWPs = 0;
	wpList = NULL;
	for (const debug_view_source *source = m_source_list.head(); source != NULL; source = source->next())
	{
		for (address_spacenum spacenum = AS_0; spacenum < ADDRESS_SPACES; spacenum++)
		{
			/* loop over the watchpoints */
			const device_debug& debugInterface = *source->device()->debug();
			for (device_debug::watchpoint *wp = debugInterface.watchpoint_first(spacenum); wp != NULL; wp = wp->next())
				numWPs++;
		}
	}
	wpList = new device_debug::watchpoint*[numWPs];

	int wpAddIndex = 0;
	for (const debug_view_source *source = m_source_list.head(); source != NULL; source = source->next())
	{
		// Collect
		for (address_spacenum spacenum = AS_0; spacenum < ADDRESS_SPACES; spacenum++)
		{
			device_debug& debugInterface = *source->device()->debug();
			for (device_debug::watchpoint *wp = debugInterface.watchpoint_first(spacenum); wp != NULL; wp = wp->next())
			{
				wpList[wpAddIndex] = wp;
				wpAddIndex++;
			}
		}
	}

	// And now for the sort
	switch (m_sortType)
	{
		case SORT_NONE:
			break;
		case SORT_INDEX_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cIndexAscending);
			break;
		case SORT_INDEX_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cIndexDescending);
			break;
		case SORT_ENABLED_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cEnabledAscending);
			break;
		case SORT_ENABLED_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cEnabledDescending);
			break;
		case SORT_CPU_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cCpuAscending);
			break;
		case SORT_CPU_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cCpuDescending);
			break;
		case SORT_SPACE_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cSpaceAscending);
			break;
		case SORT_SPACE_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cSpaceDescending);
			break;
		case SORT_ADDRESS_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cAddressAscending);
			break;
		case SORT_ADDRESS_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cAddressDescending);
			break;
		case SORT_TYPE_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cTypeAscending);
			break;
		case SORT_TYPE_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cTypeDescending);
			break;
		case SORT_CONDITION_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cConditionAscending);
			break;
		case SORT_CONDITION_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cConditionDescending);
			break;
		case SORT_ACTION_ASCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cActionAscending);
			break;
		case SORT_ACTION_DESCENDING:
			qsort(wpList, numWPs, sizeof(device_debug::watchpoint*), cActionDescending);
			break;
	}

	return numWPs;
}


//-------------------------------------------------
//  view_update - update the contents of the
//  disassembly view
//-------------------------------------------------

void debug_view_watchpoints::view_update()
{
	// Gather a list of all the watchpoints for all the CPUs
	device_debug::watchpoint** wpList = NULL;
	const int numWPs = watchpoints(SORT_NONE, wpList);

	// Set the view region so the scroll bars update
	m_total.y = numWPs+1;

	// Draw
	debug_view_char *dest = m_viewdata;
	for (int row = 0; row < m_visible.y; row++)
	{
		UINT32 effrow = m_topleft.y + row;

		// Header
		if (row == 0)
		{
			astring header;
			header.printf("ID");
			if (m_sortType == SORT_INDEX_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_INDEX_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[0]);
			header.catprintf("En");
			if (m_sortType == SORT_ENABLED_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_ENABLED_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[1]);
			header.catprintf("CPU");
			if (m_sortType == SORT_CPU_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_CPU_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[2]);
			header.catprintf("Space");
			if (m_sortType == SORT_SPACE_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_SPACE_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[3]);
			header.catprintf("Addresses");
			if (m_sortType == SORT_ADDRESS_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_ADDRESS_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[4]);
			header.catprintf("Type");
			if (m_sortType == SORT_TYPE_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_TYPE_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[5]);
			header.catprintf("Condition");
			if (m_sortType == SORT_CONDITION_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_CONDITION_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[6]);
			header.catprintf("Action");
			if (m_sortType == SORT_ACTION_ASCENDING) header.catprintf("\\");
			else if (m_sortType == SORT_ACTION_DESCENDING) header.catprintf("/");
			pad_astring_to_length(header, tableBreaks[7]);

			for (int i = 0; i < m_visible.x; i++)
			{
				dest->byte = (i < header.len()) ? header[i] : ' ';
				dest->attrib = DCA_ANCILLARY;
				dest++;
			}
			continue;
		}

		// watchpoints
		int wpi = effrow-1;
		if (wpi < numWPs && wpi >= 0)
		{
			static const char *const types[] = { "unkn ", "read ", "write", "r/w  " };
			device_debug::watchpoint* wp = wpList[wpi];

			astring buffer;
			buffer.printf("%x", wp->index());
			pad_astring_to_length(buffer, tableBreaks[0]);
			buffer.catprintf("%c", wp->enabled() ? 'X' : 'O');
			pad_astring_to_length(buffer, tableBreaks[1]);
			buffer.catprintf("%s", wp->debugInterface()->device().tag());
			pad_astring_to_length(buffer, tableBreaks[2]);
			buffer.catprintf("%s", wp->space().name());
			pad_astring_to_length(buffer, tableBreaks[3]);
			buffer.catprintf("%s-%s",
								core_i64_hex_format(wp->space().byte_to_address(wp->address()), wp->space().addrchars()),
								core_i64_hex_format(wp->space().byte_to_address_end(wp->address() + wp->length()) - 1, wp->space().addrchars()));
			pad_astring_to_length(buffer, tableBreaks[4]);
			buffer.catprintf("%s", types[wp->type() & 3]);
			pad_astring_to_length(buffer, tableBreaks[5]);
			if (astring(wp->condition()) != astring("1"))
			{
				buffer.catprintf("%s", wp->condition());
				pad_astring_to_length(buffer, tableBreaks[6]);
			}
			if (astring(wp->action()) != astring(""))
			{
				buffer.catprintf("%s", wp->action());
				pad_astring_to_length(buffer, tableBreaks[7]);
			}

			for (int i = 0; i < m_visible.x; i++)
			{
				dest->byte = (i < buffer.len()) ? buffer[i] : ' ';
				dest->attrib = DCA_NORMAL;

				// Color disabled watchpoints red
				if (i == 5 && dest->byte == 'O')
					dest->attrib = DCA_CHANGED;

				dest++;
			}
			continue;
		}

		// Fill the remaining vertical space
		for (int i = 0; i < m_visible.x; i++)
		{
			dest->byte = ' ';
			dest->attrib = DCA_NORMAL;
			dest++;
		}
	}

	delete[] wpList;
}