Compiler Construction Labs

This repository is for the lab projects in CSCI 4555/5525 and ECEN 4553/5523 Compiler Construction at the University of Colorado Boulder.

As an advanced course, these labs are designed to be open ended with a significant flexibility for your design. There is a minimal amount of starter files in this repository: a minimal run-time system for your programs, a wrapper script for your compiler pyyc, and a Makefile for your convenience. You are free to use or ignore any of these files.

Using your compiler

Your compiler should take one argument for the name of the input Python .py file to compile, and it should produce an output x86 assembly file with the same name as the input file except that the .py suffix has been replaced by the .s suffix.

Edit the wrapper script pyyc as appropriate. If your compiler main is at src/pyyc/compile.py, and you intend to use Python 3.10, then you won't need to edit this script. Otherwise you'll need to change the last line of the script as appropriate.

To run a program compiled from your compiler, you need to do something like the following, which is the sequence that the autotester follows:

• Build the run-time system (if it is not already built).

$ make -C runtime

• Build your compiler (if necessary). You may modify the Makefile as necessary to build your compiler.

$ make

• Compile the test program.

$ ./pyyc mytests/test1.py

• Link your assembly with the run-time system.

$ gcc -m32 -g mytests/test1.s runtime/libpyyruntime.a -lm -o mytests/test1

• Run your program.

$ cat mytests/test1.in | mytests/test1 > mytests/test1.out

• Generate the expected output using the python3.10 interpreter.

$ cat mytests/test1.in | python3.10 mytests/test1.py > mytests/test1.expected

• Diff your result with the expected output.

$ diff -w -B -u mytests/test1.expected mytests/test1.out

For your convenience, the Test.mk makefile (included in Makefile) has targets for these steps that you may use, modify, or ignore as you like.

Your compiler needs to produce code that runs on an x86 Linux machine.

Automated testing

Also for your convenience, the tester used in the autograder is provided for you for your own testing. To use the tester, do something like the following:

$ cd tests
$ pytest --pyyctests mytests

where tests/mytests is the directory with your custom compiler tests. A more complete set of tests can be run by replacing mytests with e.g. autograde/p0/easy, autograde/p0/medium, autograde/p0a (for all p0a tests) or autograde (for all tests), e.g.:

$ cd tests
$ pytest --pyyctests autograde

The tests in autograde will represent around half the unit tests used to grade your assignment. The other half will be hidden tests. Make sure you have pytest installed. You might want to consider using pipenv to manage your dependencies and Python environment.