Main Page
TODO: project overview here
Contents
Getting started
This section shows how to approach with nu+ project for simulating or implementing a kernel for nu+ architecture. Kernel means a complex application such as matrix multiplication, transpose of a matrix or similar that is written in a high-level programming language, for example, C/C++.
Required software
Simulation or implementation of any kernel relies on the following dependencies:
- Git
- Xilinx Vivado 2018.2 or lower or ModelSim (e.g. Questa Sim-64 vsim 10.6c_1)
- nu+ toolchain
Building process
The first step is to obtain the source code of nu+ architecture from the official repository by cloning a repository from [1]
In Ubuntu Linux environment, this step is fulfilled by starting following command:
$ git clone 'https://gitlab.com/vincenscotti/nuplus'
In the nu+ repository, toolchain consist of a sub-module of the repository so is needed to update. In Ubuntu Linux environment, just type the following command in a root folder of the repository:
$ git submodule update --init
Then, the third step is to install a toolchain. This process is described [here].
At this point, in a root folder of the repository, there are a few sub-folders. Two of these sub-folder are of particular interest for the purpose:
- software, where are stored all kernels (in a sub-folder kernel);
- tools, where are stored all scripts for simulating one or more kernel.
Simulate a kernel
For simulating a kernel there are three-way:
- starting test.sh script
- starting setup_project.sh from a root folder of the repository, if simulator software chosen is Vivado;
- starting simulate.sh from a root folder of the repository, if simulator software chosen is ModelSim.
First of all, is needed to load Vivado or ModelSim function in the shell. This step is mandatory for all ways. In Ubuntu Linux environment, if the simulator software chosen is Vivado, it can be possible by launching the following command:
$ source Vivado/folder/location/settingXX.sh
where XX depends on the installed version of Vivado (32 o 64 bit).
If simulator software chosen is ModelSim, is needed to add environment variable of ModelSim to PATH variable and load a license in the shell. In Ubuntu Linux environment, the commands to launch is:
$ export PATH=$PATH:ModelSim/folder/location/bin/
$ export LM_LICENSE_FILE=1717@vlsi2:$LM_LICENSE_FILE
test.sh script
For start test.sh script, type following command with some options in a nuplus/tools folder:
$ ./test.sh [option]
Options that can be use are:
- -h, --help show this help
- -t, --tool=vsim or vivado specify the tool to use, default: vsim
- -cn, --core-numb=VALUE specify the core number, default: 1
- -tn, --thread-numb=VALUE specify the thread number, default: 8
This script allows starting one or more kernel defined in an array of the script. The test.sh script provides to compile kernels and run them on nu+ and x86 architecture. Once the simulation is terminated, for each kernel, results of both execution are compared by a Python script for verifying the correctness of result of nu+ architecture.
In folder tools, there is a log file, called cosim.log, where are stored some information about simulation.
setup_project.sh script
For start setup_project.sh script, type following command with some options in a nuplus folder:
$ tools/vivado/setup_project.sh [option]
Options that can be used are:
- -h, --help show this help
- -k, --kernel=KERNEL_NAME specify the kernel to use
- -s, --single-core select the single core configuration, by default the manycore is selected
- -c, --core-mask=VALUE specify the core activation mask, default: 1
- -t, --thread-mask=VALUE specify the thread activation mask, default FF
- -m, --mode=gui or batch specify the tool mode, it can run in either gui or batch mode, default: gui
This script allows starting a kernel specified in the command. The kernel will compile and run on nu+ architecture. Simulation is performed by Vivado:
tools/vivado/setup_project.sh -k mmsc -c 3 -t $(( 16#F )) -m gui
About the parameters:
3 is the one-hot mask that says which core should be active: 3 is (11)2, hence 2 cores; $(( 16#F )) is the one-hot mask that says which thread should be active for a core: F is (00001111)2 so 4 threads active; gui is the mode in which execute Vivado (you can run it as batch if you prefer).
simulate.sh script
For start simulate.sh script, type following command with some options in a nuplus folder:
$ tools/modelsim/simulate.sh [option]
Options that can be used are:
- -h, --help show this help
- -k, --kernel=KERNEL_NAME specify the kernel to use
- -s, --single-core select the single core configuration, by default the manycore is selected
- -c, --core-mask=VALUE specify the core activation mask, default: 1
- -t, --thread-mask=VALUE specify the thread activation mask, default FF
- -m, --mode=gui or batch specify the tool mode, it can run in either gui or batch mode, default: gui
This script allows starting a kernel specified in command. The kernel will compile and run on nu+ architecture. Simulation is performed by ModelSim.
Implement a kernel
TODO: creazione, compilazione
TODO: clone repository, struttura cartelle
... then you can simulate or implement the system on a supported board...
Documentation
The nu+ Instruction Set Architecture
TODO Writing nu+ applications: spiegazione workflow kernel, scrittura-compilazione-file generati (altrove sara' spiegata la simulazione e il loading su scheda)
Example of nu+ applications TODO spostare contenuti in una sezione "Examples" da includere nella pagina di sopra
Progetto di Tile Eterogenea TODO: spostare altrove
Contributing to nu+ TODO: spostare i contenuti marcati come tali nel wiki
Further information on MediaWiki
TODO: da rimuovere/salvare altrove
The nu+ project documentation will be based on MediaWiki. For information and guides on using MediaWiki, please see the links below:
- User's Guide (for information on using the wiki software)
- Configuration settings list
- MediaWiki FAQ
- MediaWiki release mailing list
- Localise MediaWiki for your language
- Learn how to combat spam on your wiki
