MicroC compiler

Requirement to build the code

The code requires:

• OCaml >= 4.10.1
• Menhir >= 20200624
• ppx_deriving >= 4.5
• llvm >= 10.0.0

You can install the required dependencies via opam

$ opam install menhir ppx_deriving llvm

Here, you can find the documentation of ppx_deriving.

Here, you can find the documentation of LLVM bindings.

Building the code

Typing make will generate a microcc.native executable:

$ make

To clean-up the folder, run:

$ make clean

Testing of implementation

The directory test contains some test cases that you can use to test your implementation. Each test case consists of a small MicroC program (the file with extension *.mc) together with the result that the program is supposed to produce (the file with extension *.out).

You can run these tests with the run_tests.sh exectuable. Simply execute the following command:

$ bash run_tests.sh

Directory structure

Here is a description of content of the repository

src/                               <-- The source code lives here
Makefile                           <-- Driver for `make` (uses OCB)
_tags                              <-- OCamlBuild configuration
tests/                             <-- Some programs to test 
                                    your implementation
run_tests.sh                       <-- Script to run the unit tests

The source code

The src/ directory provides:

ast.ml                       <-- Definition of the abstract syntax tree of MicroC 
microcc.ml                   <-- The file from which build the executable 
parser_engine.ml             <-- Module to interact with the parser
codegen.ml                   <-- Module that implements the code generation
util.ml                      <-- Utility module  
opt_pass.ml                  <-- Module that implements some simple optimizations
rt-support.c                 <-- The runtime support to be linked to bitcode files produced by your compiler
parser.mly                   <-- Menhir specification of the grammar 
scanner.mll                  <-- ocamllex specification of the scanner
semant.ml                    <-- Module that implements the semantic checker
symbol_table.mli             <-- Interface of a polymorphic symbol table data type
symbol_table.ml              <-- Implementation of a polymorphic symbol table data type