1
0
mirror of https://github.com/catseye/SixtyPical.git synced 2024-11-22 17:32:01 +00:00
A 6502-oriented low-level programming language supporting advanced static analysis
Go to file
2018-03-08 17:41:42 +00:00
bin Support different preludes for different archs (c64 and vic20 now.) 2018-03-06 17:00:39 +00:00
doc I can no longer see a reason to require that it is a power of two. 2018-03-05 10:38:20 +00:00
eg Add screenshot. 2018-03-08 13:36:30 +00:00
images Add screenshot. 2018-03-08 13:36:30 +00:00
src/sixtypical Make the loop variable unwriteable in the body of the "for" loop. 2018-03-08 17:41:42 +00:00
tests Add some failing tests for analyzing "for". 2018-03-08 17:17:49 +00:00
.gitignore
HISTORY.md Try to improve the description in the documentation, and notes. 2018-03-08 13:24:00 +00:00
LICENSE Update copyright dates. 2018-03-06 15:52:55 +00:00
loadngo.sh Make loadngo.sh able to handle both C64 (x64) and VIC-20 (xvic). 2018-03-07 13:27:57 +00:00
README.md Tweaks to README. 2018-03-08 15:34:28 +00:00
test.sh

SixtyPical

Version 0.13. Work-in-progress, everything is subject to change.

SixtyPical is a 6502-assembly-like programming language with advanced static analysis.

"6502-assembly-like" means that it has similar restrictions as programming in 6502 assembly (e.g. the programmer must choose the registers that values will be stored in) and is concomitantly easy for a compiler to translate it to 6502 machine language code.

"Advanced static analysis" includes abstract interpretation, where we go through the program step by step, tracking not just the changes that happen during a specific execution of the program, but sets of changes that could possibly happen in any run of the program. This lets us determine that certain things can never happen, which we can present as safety guarantees.

In practice, this means it catches things like

  • you forgot to clear carry before adding something to the accumulator
  • a subroutine that you call trashes a register you thought was preserved
  • you tried to read or write a byte beyond the end of a byte array
  • you tried to write the address of something that was not a routine, to a jump vector

and suchlike. It also provides some convenient operations based on machine-language programming idioms, such as

  • copying values from one register to another (via a third register when there are no underlying instructions that directly support it); this includes 16-bit values, which are copied in two steps
  • explicit tail calls
  • indirect subroutine calls

The reference implementation can analyze and compile SixtyPical programs to 6502 machine code.

Quick Start

If you have the VICE emulator installed, from this directory, you can run

./loadngo.sh c64 eg/c64/hearts.60p

and it will compile the hearts.60p source code and automatically start it in the x64 emulator, and you should see:

Screenshot of result of running hearts.60p

You can try the loadngo.sh script on other sources in the eg directory tree. There is an entire small game(-like program) in demo-game.60p.

Documentation

TODO

for-like loop

We have range-checking in the abstract analysis now, but we lack practical ways to use it.

We can and a value to ensure it is within a certain range. However, in the 6502 ISA the only register you can and is A, while loops are done with X or Y. Insisting this as the way to do it would result in a lot of TXAs and TAXs.

What would be better is a dedicated for loop, like

for x in 0 to 15 {
    // in here, we know the range of x is exactly 0-15 inclusive
    // also in here: we are disallowed from changing x
}

However, this is slightly restrictive, and hides a lot.

However however, options which do not hide a lot, require a lot of looking at (to ensure: did you increment the loop variable? only once? etc.)

The leading compromise so far is an "open-faced for loop", like

ld x, 15
for x downto 0 {
    // same as above
}

This makes it a little more explicit, at least, even though the loop decrementation is still hidden.

Save registers on stack

This preserves them, so that, semantically, they can be used later even though they are trashed inside the block.

Re-order routines and optimize tail-calls to fallthroughs

Not because it saves 3 bytes, but because it's a neat trick. Doing it optimally is probably NP-complete. But doing it adequately is probably not that hard.

And at some point...

  • low and high address operators - to turn word type into byte.
  • consts that can be used in defining the size of tables, etc.
  • Tests, and implementation, ensuring a routine can be assigned to a vector of "wider" type
  • Related: can we simply view a (small) part of a buffer as a byte table? If not, why not?
  • Check that the buffer being read or written to through pointer, appears in approporiate inputs or outputs set. (Associate each pointer with the buffer it points into.)
  • static pointers -- currently not possible because pointers must be zero-page, thus @, thus uninitialized.
  • Question the value of the "consistent initialization" principle for if statement analysis.
  • interrupt routines -- to indicate that "the supervisor" has stored values on the stack, so we can trash them.
  • Add absolute addressing in shl/shr, absolute-indexed for add, sub, etc.
  • Automatic tail-call optimization (could be tricky, w/constraints?)
  • Possibly ld x, [ptr] + y, possibly st x, [ptr] + y.
  • Maybe even copy [ptra] + y, [ptrb] + y, which can be compiled to indirect LDA then indirect STA!