Project 2: CS61Classify

Part A Deadline: Wednesday, September 21, 11:59:59 PM PT

Part B Deadline: Wednesday, October 5, 11:59:59 PM PT

In this project, you will write RISC-V assembly code to classify handwritten digits with a simple machine learning algorithm.

The goal of this project is to familiarize you with RISC-V, specifically calling convention, calling functions, using the heap, interacting with files, and writing some tests.

Content in scope for this project: Lectures 7-9, Lab 3-4, Homework 4. Also, make sure you've finished the setup in Lab 0.

Office Hour and Ed Policy

Before coming to office hours or posting a question on Ed, please make sure you have done the following:

  1. Add descriptions for each register in your functions to indicate their purpose ("this holds i" is too vague, please be as specific as possible so it is easier for us to read and comprehend your code.)
  2. Read the calling convention guide.
  3. Use calling convention checker and resolve all calling convention errors caught by the checker (unless your question is specifically about how to fix these errors).
  4. Use memcheck and resolve all memory access errors (unless your question is specifically about how to fix these errors).
  5. Watch the debugging videos (linked below).

Make sure to fill out the template on Ed/OH Queue with as much description as possible. Questions that do not use the template or have very low-effort descriptions (such as "it doesn't work") will be skipped/deleted.

Debugging Videos

Check out this playlist for videos demonstrating how to debug memory and calling convention issues! Please make sure you've watched these videos before coming to office hours or posting a question on Ed.

Setup: Git

This assignment can be done alone or with a partner.

Warning: Once you create a Github repo, you will not be able to change (add, remove, or swap) partners for this project (both 2A and 2B), so please be sure of your partner before starting the project. You must add your partner on both galloc and to every Gradescope submission.

If there are extenuating circumstances that require a partner switch (e.g. your partner drops the class, your partner is unresponsive), please reach out to us privately.

  1. Visit Galloc. Log in and start the Project 2 assignment. This will create a GitHub repository for your work.

  2. Clone the repository on your local machine (you don't need the hive machine at all for this project). Windows users should clone in Git Bash.

    git clone 61c-proj2

(replace username with your GitHub username)

  1. Navigate to your repository:

    cd 61c-proj2
  2. Add the starter repository as a remote:

    git remote add starter

Setup: Java and Python

Make sure that you followed the local computer setup directions in Exercise 2 of Lab 0.

Setup: Venus

We will use the Venus web interface for debugging. The procedure is very similar to the Venus setup in Lab 3.

  1. In the 61c-proj2 directory, run bash download_tools to download Venus for this project. (You only need to run this once.)

  2. On your local computer (not the hive), navigate to your 61c-proj2 directory and run this command. Windows users should run outside WSL (Git Bash is recommended).

    java -jar tools/venus.jar . -dm
  3. In your web browser, open (Chrome or Firefox is recommended). In the Venus web terminal, run mount local vmfs. In your browser, you may see a prompt saying Key has been shown in the Venus mount server! Please copy and paste it into here. You should be able to see a key (string of letters and numbers) in the most recent line of your local terminal output; copy and paste the key into the dialog.

  4. Now the project files from your local computer are loaded into the Venus web interface. In Venus, you can open the Files tab or run ls vmfs in the Venus terminal to see all your files in your browser.

If you can see your files in Venus, you can skip the rest of this section. If the above steps didn't work, you can follow the guide below to manually upload files.

Manually Uploading Files
  1. On your local computer or on the hive, zip your src, tests, and test-src directories.

  2. Navigate to Type upload in the Venus terminal.

  3. A file upload prompt should appear. Upload the zip file you created in step 1.

Now you can edit and debug your files on Venus.

To download any files you've edited, you can run zip zipname file1 file2 file3 in the Venus terminal. Replace zipname with whatever you want the downloaded zip file to be named. Replace file1 file2 file3 with a list of files or directories you want to download (there can be more or less than 3 files or directories).

Restoring Starter Files

While running tests, if you see an error message like "tests/file.txt was changed from starter", this means that you accidentally modified one of the starter files that you shouldn't change. To restore the original file from the starter repo, run

git checkout starter/main tests/file.txt

replacing tests/file.txt with the filepath that you saw in the error message. If there's an error about an "unknown revision" or "unknown ref", try running the following command first.

git fetch starter