coreman

.\" Manpage for core.
.\" Contact rouhiermax@cy-tech.fr or taalbibila@cy-tech.fr to correct errors or typos.
.TH core 0 "17 Dec 2021" "1.0" "core man page"
.SH NAME
core \- example of virtual core 
.SH SYNOPSIS
.B core 
[
.B -v
]
[ 
.B -h
] 
.I code_file
.I state_file
.SH DESCRIPTION
.B core
is an executable file able to run on an up-to-date 64 bits Debian distribution. The core is composed of three main functions
.B fetch
,
.B decode
and 
.B execute.
.RE
  
.RE
.B Fetch 
reads the instruction from the code and compute the new value of the PC.
.RE
.B Decode
decode the different parts from the instruction.
.RE
.B Execute
realize the operations. 
.RE

.RE
We provided a python3 compiler that work with an assembly-like program. (compiler.py)
.RE
Note that the compiler will not work if you dont put spaces between the instructions.
.RE
E.g. "ADD r1, r2, 3" 
.SH OPTIONS
.IP -h 
Display this manual.
.IP -v 
Enable verbose mode. 
.SH FILES
.I code_file
.RS 
It specifies the code (binary file) to be executed by the core (MANDATORY)
.RE
.I state_file
.RS 
It specifies the initial state of the internal registers (MANDATORY)
.SH BUGS
No error handling with the state file (value must increase from 0 to ... step by step). Working with the 3 first programs.
.SH EXAMPLE
 (python3 compiler.py instructions.s && make &&) ./core code state.txt
.SH SEE MORE
consignes.pdf
.SH AUTHORS
Bilal Taalbi (taalbibila@cy-tech.fr) & Maxime Rouhier (rouhiermax@cy-tech.fr)