projet_systeme_info/README.md
2021-05-28 10:04:46 +02:00

109 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Projet Système Info
### Yohan SIMARD - Arnaud VERGNET
4IR A1 2020-2021
Ce dépôt inclut notre compilateur, un cross assembleur et le code VHDL de notre processeur.
## Fonctionnalités du parser
- Déclaration de variables
- Affectation de variables
- Calculs (addition, soustraction, division, multiplication)
- Fonction main
- Branches (if, else)
- Conditions (!, ||, &&, ==, !=, <, <=, >, >=)
- Boucle while
- printf
## Fonctionnalités du compilateur
Toutes les fonctionnalités du parser sauf les boucles while (par manque de temps).
## Fonctionnalités du processeur
- Affectation, calculs (sauf division), copie, store, load
- Pipeline à 5 étage
- Gestion des aléas si écriture puis lecture dans le même registre
## Installation
Voici les commandes à entrer dans un terminal pour récupérer, compiler et exécuter le projet:
```shell
# Clone le dépôt git avec les submodules
git clone --recurse-submodules https://git.etud.insa-toulouse.fr/ysimard/projet_systeme_info.git
cd projet_systeme_info
# Compile le compilateur et le cross assembleur
make
# Exécute le compilateur et le cross assembleur sur le fichier test.c
make test_cross_bin.txt
```
## Description des dépôts
### Compilateur (compilator-2000)
#### Structure
Ce dépôt contient tous les fichiers nécessaires au fonctionnement du parser et du compilateur, ainsi que des tests unitaires pour la table des symboles. Il contient aussi un interpréteur (dossier `interpreter`), fourni par les professeurs, pour vérifier le code assembleur généré.
En plus des fichiers `al.lex` et `as.y` classiques, ce projet contient plusieurs fichiers `C` utilitaires. `asm_instructions` se charge de modifier le tableau dinstruction assembleur et de lécrire dans un fichier. `symbol_table` soccupe de modifier et lire la table des symboles. `symbole_table.test.c` execute des tests unitaires sur le fichier précédent. `yacc_util` est un ensemble de fonctions utilitaires pour simplifier la manipulation de la table des symboles et des instructions assembleur, utilisé par `as.y`.
#### Compilation et lancement
Un `Makefile` est fourni pour compiler le projet, qui sutilise comme suit:
- Compiler le compilateur
```shell
make compilateur
```
- Compiler les tests unitaires
```shell
make test
```
- Nettoyer le projet
```shell
make clean
```
Une fois compilé, le compilateur s'exécute de la manière suivante (en remplaçant `INPUT_FILE` par le fichier `C` souhaité et `OUTPUT_FILE` par le fichier destination voulu):
```shell
./compilateur [OUTPUT_FILE] < INPUT_FILE
```
Pour lancer les tests unitaires, exécuter la commande suivante:
```shell
./test
```
Pour vérifier le code assembleur à laide de linterpréteur, copier le contenu du fichier de sortie du compilateur dans le fichier `interpreter/input.txt`, compiler l'interpréteur à laide de la commande `make`, et exécuter la commande suivante:
```shell
./interpreter < input.txt
```
#### Particularités de limplémentation
##### Tables
Toutes nos tables sont implémentées sous la forme de tableaux. Nous avons préféré cette approche plutôt que des listes chaînées car nous itérons souvent dessus, ce qui est très lent quand les données sont éparpillées dans la mémoire, comme dans le cas des listes chaînées.
Ceci implique cependant que nous avons un nombre dinstructions et un nombre de symboles maximum.
##### Tests unitaires
Nous avons écrit des tests unitaires pour la table des symboles. Dans ces tests, nous créons une table des symboles, ajoutons des éléments, et vérifions quils sont bien présents après. Nous testons aussi les erreurs retournées par les fonctions.
##### Fonctions utilitaires
Pour éviter davoir un fichier yacc trop imposant, nous avons créé un fichier `yacc_util.c` qui contient toutes les fonctions qui écrivent des instructions dans la table des instructions.
### Cross-assembleur (crossassembler-2000)
Le cross-assembleur a été écrit en majorité par Paul Faure. Nous lavons simplement adapté pour notre compilateur et notre processeur.
Il est optimisé car il ne génère par un LOAD et un STORE pour chaque instruction. Il se souvient de quelle donnée est présente dans quel registre.
#### Compilation et lancement
Compiler
```shell
make
```
Nettoyer le projet
```shell
make clean
```
### Processeur (processor-2000)
#### Simulation et tests
Ouvrir le projet dans ISE et lancer la simulation. Le fichier `config_simu.wcfg` contient une configuration du simulateur qui permet de visualiser tous les signaux intéressants.