.. _debugger-general-list: General Debugger Commands ========================= You can also type **help ** for further details on each command in the MAME Debugger interface. | :ref:`debugger-command-do` -- evaluates the given expression | :ref:`debugger-command-symlist` -- lists registered symbols | :ref:`debugger-command-softreset` -- executes a soft reset | :ref:`debugger-command-hardreset` -- executes a hard reset | :ref:`debugger-command-print` -- prints one or more s to the console | :ref:`debugger-command-printf` -- prints one or more s to the console using | :ref:`debugger-command-logerror` -- outputs one or more s to the error.log | :ref:`debugger-command-tracelog` -- outputs one or more s to the trace file using | :ref:`debugger-command-tracesym` -- outputs one or more s to the trace file | history -- outputs a brief history of visited opcodes (**to fix: help missing for this command**) | :ref:`debugger-command-trackpc` -- visually track visited opcodes [boolean to turn on and off, for the given CPU, clear] | :ref:`debugger-command-trackmem` -- record which PC writes to each memory address [boolean to turn on and off, clear] | :ref:`debugger-command-pcatmem` -- query which PC wrote to a given memory address for the current CPU | :ref:`debugger-command-rewind` -- go back in time by loading the most recent rewind state | :ref:`debugger-command-statesave` -- save a state file for the current driver | :ref:`debugger-command-stateload` -- load a state file for the current driver | :ref:`debugger-command-snap` -- save a screen snapshot. | :ref:`debugger-command-source` -- reads commands from and executes them one by one | :ref:`debugger-command-quit` -- exits MAME and the debugger .. _debugger-command-do: do -- | **do ** | | The do command simply evaluates the given . This is typically used to set or modify variables. | | Examples: | | do pc = 0 | | Sets the register 'pc' to 0. | | Back to :ref:`debugger-general-list` .. _debugger-command-symlist: symlist ------- | **symlist []** | | Lists registered symbols. If is not specified, then symbols in the global symbol table are displayed; otherwise, the symbols for 's specific CPU are displayed. Symbols are listed alphabetically. Read-only symbols are flagged with an asterisk. | | Examples: | | symlist | | Displays the global symbol table. | | symlist 2 | | Displays the symbols specific to CPU #2. | | Back to :ref:`debugger-general-list` .. _debugger-command-softreset: softreset --------- | **softreset** | | Executes a soft reset. | | Examples: | | softreset | | Executes a soft reset. | | Back to :ref:`debugger-general-list` .. _debugger-command-hardreset: hardreset --------- | **hardreset** | | Executes a hard reset. | | Examples: | | hardreset | | Executes a hard reset. | | Back to :ref:`debugger-general-list` .. _debugger-command-print: print ----- | **print [,...]** | | The print command prints the results of one or more expressions to the debugger console as hexadecimal values. | | Examples: | | print pc | | Prints the value of 'pc' to the console as a hex number. | | print a,b,a+b | | Prints a, b, and the value of a+b to the console as hex numbers. | | Back to :ref:`debugger-general-list` .. _debugger-command-printf: printf ------ | **printf [,[,...]]** | | The printf command performs a C-style printf to the debugger console. Only a very limited set of formatting options are available: | | %[0][]d -- prints as a decimal value with optional digit count and zero-fill | %[0][]x -- prints as a hexadecimal value with optional digit count and zero-fill | | All remaining formatting options are ignored. Use %% together to output a % character. Multiple lines can be printed by embedding a \\n in the text. | | Examples: | | printf "PC=%04X",pc | | Prints PC= where is displayed in hexadecimal with 4 digits with zero-fill. | | printf "A=%d, B=%d\\nC=%d",a,b,a+b | | Prints A=, B= on one line, and C= on a second line. | | Back to :ref:`debugger-general-list` .. _debugger-command-logerror: logerror -------- | **logerror [,[,...]]** | | The logerror command performs a C-style printf to the error log. Only a very limited set of formatting options are available: | | %[0][]d -- logs as a decimal value with optional digit count and zero-fill | %[0][]x -- logs as a hexadecimal value with optional digit count and zero-fill | | All remaining formatting options are ignored. Use %% together to output a % character. Multiple lines can be printed by embedding a \\n in the text. | | Examples: | | logerror "PC=%04X",pc | | Logs PC= where is displayed in hexadecimal with 4 digits with zero-fill. | | logerror "A=%d, B=%d\\nC=%d",a,b,a+b | | Logs A=, B= on one line, and C= on a second line. | | Back to :ref:`debugger-general-list` .. _debugger-command-tracelog: tracelog -------- | **tracelog [,[,...]]** | | The tracelog command performs a C-style printf and routes the output to the currently open trace file (see the 'trace' command for details). If no file is currently open, tracelog does nothing. Only a very limited set of formatting options are available. See the :ref:`debugger-command-printf` help for details. | | Examples: | | tracelog "PC=%04X",pc | | Outputs PC= where is displayed in hexadecimal with 4 digits with zero-fill. | | printf "A=%d, B=%d\\nC=%d",a,b,a+b | | Outputs A=, B= on one line, and C= on a second line. | | Back to :ref:`debugger-general-list` .. _debugger-command-tracesym: tracesym -------- | **tracesym [,...]** | | The tracesym command prints the specified symbols and routes the output to the currently open trace file (see the 'trace' command for details). If no file is currently open, tracesym does nothing. | | Examples: | | tracelog pc | | Outputs PC= where is displayed in the default format. | | Back to :ref:`debugger-general-list` .. _debugger-command-trackpc: trackpc ------- | **trackpc [,,]** | | The trackpc command displays which program counters have already been visited in all disassembler windows. The first boolean argument toggles the process on and off. The second argument is a CPU selector; if no CPU is specified, the current CPU is automatically selected. The third argument is a boolean denoting if the existing data should be cleared or not. | | Examples: | | trackpc 1 | | Begin tracking the current CPU's pc. | | trackpc 1, 0, 1 | | Continue tracking pc on CPU 0, but clear existing track info. | | Back to :ref:`debugger-general-list` .. _debugger-command-trackmem: trackmem -------- | **trackmem [,,]** | | The trackmem command logs the PC at each time a memory address is written to. The first boolean argument toggles the process on and off. The second argument is a CPU selector; if no CPU is specified, the current CPU is automatically selected. The third argument is a boolean denoting if the existing data should be cleared or not. Please refer to the pcatmem command for information on how to retrieve this data. Also, right clicking in a memory window will display the logged PC for the given address. | | Examples: | | trackmem | | Begin tracking the current CPU's pc. | | trackmem 1, 0, 1 | | Continue tracking memory writes on CPU 0, but clear existing track info. | | Back to :ref:`debugger-general-list` .. _debugger-command-pcatmem: pcatmem ------- | **pcatmem(p/d/i)
[,]** | | **pcatmemp
[,]** -- query which PC wrote to a given program memory address for the current CPU | **pcatmemd
[,]** -- query which PC wrote to a given data memory address for the current CPU | **pcatmemi
[,]** -- query which PC wrote to a given I/O memory address for the current CPU (you can also query this info by right clicking in a memory window) | | The pcatmem command returns which PC wrote to a given memory address for the current CPU. The first argument is the requested address. The second argument is a CPU selector; if no CPU is specified, the current CPU is automatically selected. Right clicking in a memory window will also display the logged PC for the given address. | | Examples: | | pcatmem 400000 | | Print which PC wrote this CPU's memory location 0x400000. | | Back to :ref:`debugger-general-list` .. _debugger-command-rewind: rewind ------ | **rewind[rw]** | | The rewind command loads the most recent RAM-based state. Rewind states, when enabled, are saved when "step", "over", or "out" command gets executed, storing the machine state as of the moment before actually stepping. Consecutively loading rewind states can work like reverse execution. Depending on which steps forward were taken previously, the behavior can be similar to GDB's "reverse-stepi" or "reverse-next". All output for this command is currently echoed into the running machine window. Previous memory and PC tracking statistics are cleared, actual reverse execution does not occur. | | Back to :ref:`debugger-general-list` .. _debugger-command-statesave: statesave --------- | **statesave[ss] ** | | The statesave command creates a save state at this exact moment in time. The given state file gets written to the standard state directory (sta), and gets .sta added to it - no file extension necessary. All output for this command is currently echoed into the running machine window. | | Examples: | | statesave foo | | Writes file 'foo.sta' in the default state save directory. | | Back to :ref:`debugger-general-list` .. _debugger-command-stateload: stateload --------- | **stateload[sl] ** | | The stateload command retrieves a save state from disk. The given state file gets read from the standard state directory (sta), and gets .sta added to it - no file extension necessary. All output for this command is currently echoed into the running machine window. Previous memory and PC tracking statistics are cleared. | | Examples: | | stateload foo | | Reads file 'foo.sta' from the default state save directory. | | Back to :ref:`debugger-general-list` .. _debugger-command-snap: snap ---- | **snap [[], ]** | | The snap command takes a snapshot of the current video display and saves it to the configured snapshot directory. If is specified explicitly, a single screenshot for is saved under the requested filename. If is omitted, all screens are saved using the same default rules as the "save snapshot" key in MAME proper. | | Examples: | | snap | | Takes a snapshot of the current video screen and saves to the next non-conflicting filename in the configured snapshot directory. | | snap shinobi | | Takes a snapshot of the current video screen and saves it as 'shinobi.png' in the configured snapshot directory. | | Back to :ref:`debugger-general-list` .. _debugger-command-source: source ------ | **source ** | | The source command reads in a set of debugger commands from a file and executes them one by one, similar to a batch file. | | Examples: | | source break_and_trace.cmd | | Reads in debugger commands from break_and_trace.cmd and executes them. | | Back to :ref:`debugger-general-list` .. _debugger-command-quit: quit ---- | **quit** | | The quit command exits MAME immediately. | | Back to :ref:`debugger-general-list` 88 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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574