1
0
mirror of https://github.com/specht/champ.git synced 2024-11-03 17:05:08 +00:00

documentation for subroutine cycle watches

This commit is contained in:
Michael Specht 2018-02-16 21:50:01 +01:00
parent f210a8de87
commit 717f6758f9
9 changed files with 60 additions and 9 deletions

View File

@ -63,7 +63,7 @@ You can watch registers or variables at certain program counter addresses by ins
FOO EQU $8000
JSR TEST
RTS
BRK
TEST LDA #64 ; load 64 into accumulator
ASL ; multiply by two @Au
@ -94,7 +94,7 @@ In addition to watching individual registers, you can also watch global variable
FOO EQU $8000 ; @u16
JSR TEST
RTS
BRK
TEST LDA #0
STA FOO
@ -114,10 +114,10 @@ Here's another example with some more interesting plots ([example03.yaml](exampl
MX %11
ORG $6000
FOO EQU $8000
FOO EQU $8000 ; @u8
JSR TEST
RTS
BRK
TEST LDX #$FF
LDA #1
@ -130,8 +130,9 @@ LOOP TAY
TYA
CLC
ADC FOO ; @Au(post)
DEX ; @Xu(post)
DEX ; @Xu(post) @Au,FOO(post)
BNE LOOP
RTS
```
This is a small program which lets the accumulator grow exponentially while X decreases linearly:
@ -151,6 +152,36 @@ This will plot FOO against X:
![FOO against A at PC 0x6015](doc/example03_3.gif?raw=true)
### Subroutine cycle watches
If you want to know the distribution of cycles spent in certain subroutines, use the `@cycles` directive to add a watch for this information:
```
DSK test
MX %11
ORG $6000
LDX #$20
JSR COUNT
LDX #$30
JSR COUNT
LDX #$40
JSR COUNT
BRK
COUNT DEX ; @Xu(post) @cycles
BNE COUNT
RTS
```
This programm calls the `COUNT` subroutine three times with different X arguments, and we get both X and the number of cycles spent in `COUNT`:
![X at PC 0x6010](doc/example04_1.gif?raw=true)
![COUNT cycles](doc/example04_2.gif?raw=true)
We see the three incantations of `COUNT` with `X` decreasing to 0 each time, and at the end of every loop, the amount of cycles spent in `COUNT`.
### Disabling watches
To disable a watch, add a `;` right behind the `@`:

View File

@ -584,7 +584,7 @@ class Champ
end
end
if @cycles_per_function.include?(watch[:pc])
if (!@watch_values.include?(index)) && @cycles_per_function.include?(watch[:pc])
max_cycle_count_for_function = @cycles_per_function[watch[:pc]].map do |x|
x[:call_cycles]
end.max

BIN
doc/example04_1.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

BIN
doc/example04_2.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB

View File

@ -5,7 +5,7 @@
FOO EQU $8000
JSR TEST
RTS
BRK
TEST LDA #64 ; load 64 into accumulator
ASL ; multiply by two @Au

View File

@ -5,7 +5,7 @@
FOO EQU $8000 ; @u16
JSR TEST
RTS
BRK
TEST LDA #0
STA FOO

View File

@ -5,7 +5,7 @@
FOO EQU $8000 ; @u8
JSR TEST
RTS
BRK
TEST LDX #$FF
LDA #1
@ -20,3 +20,4 @@ LOOP TAY
ADC FOO ; @Au(post)
DEX ; @Xu(post) @Au,FOO(post)
BNE LOOP
RTS

16
examples/example04.s Normal file
View File

@ -0,0 +1,16 @@
DSK test
MX %11
ORG $6000
LDX #$20
JSR COUNT
LDX #$30
JSR COUNT
LDX #$40
JSR COUNT
BRK
COUNT DEX ; @Xu(post) @cycles
BNE COUNT
RTS

3
examples/example04.yaml Normal file
View File

@ -0,0 +1,3 @@
load:
0x6000: example04.s
entry: 0x6000