Skip to main content

Python implementation of the Little Man Computer with additional SFT instruction.

Project description

PaperPC

PyPI version

A python implementation of the Little Man Computer meant for use in CI/CD (i.e. GitHub Actions) to verify student programs using the LMC ISA. This implementation uses the traditional instruction set plus one additional instruction meant to emulate bit-shifting (as implemented using another paper computer, the CARDIAC).

Install

This project is available via PyPI: python -m pip install paperpc.

ISA

Numeric syntax Mnemonic equivalent Instruction Description Destructive
1xx ADD ADD Adds a number stored in a memory location xx to the Accumulator Yes
2xx SUB SUBTRACT Subtracts a number stored in a memory location xx from the Accmumulator Yes
3xx STA STORE Stores the value of the Accumulator in memory location xx No
4lr SFT SHIFT Shifts Accumulator value l places to the left, r places to the right Yes
5xx LDA LOAD Loads a number stored in memory location xx to the Accumulator Yes
6xx BRA UNCONDITIONAL BRANCH Sets the Program Counter to value xx, preparing to execute value in xx No
7xx BRZ BRANCH IF ZERO Verifies Accumulator value is 0; if so, set Program Counter to value xx, prepare to execute value in xx No
8xx BRP BRANCH IF POSITIVE Verifies Accumulator value is greater than 0; if so, set Program Counter to value xx, prepare to execute value in xx No
901 INP INPUT Read a single value fromw waiting input, replace Accumulator value Yes
902 OUT OUTPUT Output the current value of the Accumulator No
000 HLT HALT Terminates program

Using the program

Invoke the package via the CLI script: paperpc example.ppc --inputs 2,3

Here, add the command flag --inputs after the name of the script followed by a comma-separated list of values to include as inputs to the machine. The program will parse the correct input when encountering the 901 instruction. Think of it like a stack, except it's FIFO rather than LIFO. So, not really a stack.

Implementation-specific details

General note: all programs must terminate using a 000 (HLT) instruction.

Inputs

The following program adds any two numbers from input:

1    901    @ Read one value from input to Accumulator
2    360    @ Store in memory location 060
3    901    @ Read one value from input to Accumulator
4    648    @ Unconditional branch to data in 048
48   160    @ Add data in 060 to Accumulator
49   902    @ Output the sum stored in the Accumulator
50   000    @ Halt

Branching

The following program uses BRP and BRZ to perform a countdown from any given input:

001     901 @ Read starting value from input to Accumulator
002     350 @ Store value in memory space 50
003     902 @ Output value currently in Accumulator
004     251 @ Subtract a bootstrapped 1 in memory location 51
005     740 @ Branch to end if Accumulator value is 0
006     803 @ Branch to 003 if Accumulator value is positive
040     000 @ Halt
051     001 @ Bootstrap a 1

Shifting

Routine below shifts a number (such as 200) right 2 times, 1 left to produce a value like (e.g. 2):

001     901 @ Read starting value from input to Accumulator
002     402 @ Shift 2 right
003     410 @ Shift 1 left
004     902 @ Output value of Accumulator
005     000 @ Halt

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paperpc-0.3.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paperpc-0.3.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file paperpc-0.3.0.tar.gz.

File metadata

  • Download URL: paperpc-0.3.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for paperpc-0.3.0.tar.gz
Algorithm Hash digest
SHA256 da300f2ec9b6d1531330bdd05977dfd379cd3c38ad218e0c76ce10ee1d6ba174
MD5 a099d84bbbec41c3fbd312f0a1818495
BLAKE2b-256 eb0f9787333c885dc8e09c4fbd76ffcaa2a9bdfb21fa4ecd391bf299f8b5f7e2

See more details on using hashes here.

File details

Details for the file paperpc-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: paperpc-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for paperpc-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45d33b27e7516c6a21c8b25d1f42104450ae10c9b609cb8fffe5c8d4ba58c68d
MD5 8366701538f83813b5d36913330e2d7e
BLAKE2b-256 9eb3516ce80bba1e1ae4e10fdfea5b8bd6d4c523363b010f58245ed326d5459e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page