The top level directory structure of the parun environment is:

parun/	Root parun environment for our JoeQ distribution
parun/bin/	Contains the parun scripts to set up the environment and launch analyses
parun/lib/	Contains the Joeq JAR. Unzip the JAR to see the JoeQ source.
parun/src/	Contains examples, as well as stubs for your code
parun/Makefile	Compiles all the src .java files into a jar, ready to be run using the parun script

The src directory contains the source files that you'll be using and creating for this programming assignment. This includes the following subdirectories/packages:

parun/src/examples/	Contains example analyses, such as PrintQuads, discussed in the JoeQ tutorial.
parun/src/flow/	Contains the dataflow analysis framework and example analyses. The file Flow.java contains the interfaces you have to implement and the main program.
parun/src/test/	Contains several tests for your dataflow implementation. More info below.
parun/src/submit/	Contains the stubs for the code you have to write - MySolver.java and ReachingDefs.java

Your task is twofold:

1. Create a class MySolver that implements the interface Flow.Solver. Use it to run the constant propagation and liveness algorithms we provide.
2. Create a class ReachingDefs that implements the interface Flow.Analysis and executes the reaching definitions analysis.

Running Analyses

To run the PrintQuads example from the joeq tutorial that printed out the basic blocks of the ExprTest class using the parun environment, simply make the environment and invoke the parun script on the PrintQuads and ExprTest:

myth:~$ cd parun
myth:~/parun$ make
myth:~/parun$ bin/parun examples.PrintQuads examples.ExprTest

To run MySolver using the ConstantProp analysis over a test program called Test, invoke the parun script on these four classes:

myth:~/parun$ bin/parun flow.Flow submit.MySolver flow.ConstantProp test.Test

Testing your code

The test package contains a Test class that you can use to test your implementation of MySolver and ReachingDefs. The parun/src/test/ directory contains Test.cp.out, Test.lv.out, and Test.rd.out which are output files for running the ConstantProp, Liveness, and ReachingDefs analyses over the Test class.

Diff the output of running your MySolver with these out files to test your implementation.

We ONLY want the java files in your src/submit directory, do not submit the rest of the framework.

To submit your assignment, please follow the following steps:

1. Copy your hw2's src/submit directory to myth.stanford.edu (keep it in it's own directory)
2. Login to myth.stanford.edu
3. cd to the directory containing only the java files you want to submit
4. run /usr/class/cs243/dataflow/submit_hw2.sh in this directory.
   OR, if you're working with a partner, type:
   /usr/class/cs243/dataflow/submit_hw2.sh partner_SUID
5. (ex: ./submit_hw2.sh jongsoo)

Only one submission is required per pair. If you discover a bug after submitting (and before the due date), simply run the submission script again. We'll take the latest version.

Get started early. This is a sizable project, and you need to familiarize yourself with joeq at the same time. If you wait until the last minute, you will not be able to finish.

Look at the ConstantProp and Liveness classes. You will find techniques that will be useful to you when you formulate ReachingDefs.

Read the joeq documentation carefully, and don't hesitate to look at the full javadocs if you get stuck. Joeq is still very much an experimental system; if you wish to attempt something particularly tricky, you may find it enlightening to sourcedive.

Study the QuadIterator interface carefully. It does a great deal of the work for you. But please take note: if you construct a backward QuadIterator, you must iterate over it with hasPrevious() and previous().

DataflowObjects are mutable; when in doubt, copy them. When writing reaching definitions, be sure to implement an equals() method, or your code will loop forever.

The iterator returned by Quad.successors() (resp. Quad.predecessors()) generates null to indicate that the current object has the exit node (resp. entry node) as a successor (resp. predecessor).

Joeq doesn't work with Java 1.6 class files. The provided Makefile deals with this for you, but if you invoke javac yourself, be sure to pass -target 1.5 and make sure everything compiles with the provided Makefile