Dynamic processor

This extension allows you to compile and run code snippets in different languages (C and C++ at this time), and with different compilers.

1. Usage

We present the different options that you can use with the dynamic processor.

%dynamic: The block should start with the %dynamic directive, so that the processor can identify it.
language: The programming language of the code block. It is usefull on the one hand because it allows the processor to display correctly the code block, and on the other hand because it allows the processor to know which compiler to use.
filename: The name of the file where the code block will be saved. If the file already exists, it will be overwritten. If nothing is specified, the file will be of the tmp_1738748912630.cpp (depending on the date and the file format specified).
compile: The type of compilation that will be done, in one of the following:
- sh or cpp: The code will be compiled with the g++ compiler. Default is sh.
- c: The code will be compiled with the gcc compiler.
- mpi: The code will be compiled with the mpicxx compiler.
- make: The code will be compiled with the make command.
- cmake: The code will be compiled with the cmake command. (not implemented yet) Note that for the two last options, the page should contain the source of the Makefile or the CMakeLists.txt file. See example below.
inputs: The arguments that will be passed to the program during the execution.
comp-args: The arguments that will be passed to the compiler during the compilation, if none are specified, the default arguments are -std=c++17.
run: Tells if the program is executed or not (default is true).
build: Build directory (for CMake), default is build.
exec: The name of the executable file that will be created. If nothing is specified, the file will be of the form Helloworld.exe.
np: The number of processes that will be used for the MPI compilation. Default is 2.

The three asciidoctor extensions should be loaded in that order in the site.yml file:

cmake-dynamic-processor.js
makefile-dynamic-processor.js
dynamic-processor.js

2. Example

2.1. Example of a C++ code

[%dynamic, cpp, filename="Hello.cpp", compile=sh, inputs="arg1 arg2 arg3"]

Test compile C++

#include <iostream>

int main(int argc, char **argv)
{
    for (int i=0; i<argc; i++)
        std::cout << argv[i] << std::endl;
    std::cout << "Hello, world!" << std::endl;
    return 0;
}

2.2. Example of a C code

[%dynamic, c, filename="Hello.c", compile=c, args="arg1 arg2 arg3", comp-args="-Wall -Wextra -Werror"]

Test compile C

#include <stdio.h>

int main(int argc, char **argv)
{
    for (int i=0; i<argc; i++)
        printf("%s\n", argv[i]);
    printf("Hello, world!\n");
    return 0;
}

2.3. Example of a MPI code

[%dynamic, c, filename="MPI_Allgather.c", compile=mpi, np=3]

Test compile MPI

#include <mpi.h>
#include <stdio.h>

int main(int argc, char **argv)
{
    MPI_Init(&argc, &argv);
    int rank;
    MPI_Comm_rank(MPI_COMM_WORLD, &rank);
    printf("Hello from process %d\n", rank);
    MPI_Finalize();
    return 0;
}

2.4. Example of a code with OpenMP

[%dynamic, cpp, filename="HelloWorld_omp.cpp", compile=openmp]

Test compile OpenMP

#include <iostream>
#include <omp.h>

int main(int argc, char* argv[])
{
	// Use 4 OpenMP threads
	omp_set_num_threads(4);

	// Variable that will be private
	int val = 123456789;

	printf("Value of \"val\" before the OpenMP parallel region: %d.\n", val);
	#pragma omp parallel private(val)
	{
		printf("Thread %d sees \"val\" = %d, and updates it to be %d.\n", omp_get_thread_num(), val, omp_get_thread_num());
		val = omp_get_thread_num();
	}
	// Value after the parallel region; unchanged.
	printf("Value of \"val\" after the OpenMP parallel region: %d.\n", val);
	return 0;
}

2.5. Example of a compilation with CMake

[%dynamic, cmake]

cmake_minimum_required(VERSION 3.0)
project(HelloWorld)
add_executable(HelloWorld HelloWorldCMake.cpp)

#include <iostream>

int main(int argc, char **argv)
{
    for (int i = 1; i < argc; ++i)
        std::cout << argv[i] <<  " ";
    std::cout << std::endl;
    return 0;
}

2.6. Example of a code with Makefile

[%dynamic, makefile, filename="Makefile"]

# Spécifie le compilateur à utiliser
CXX = g++

# Spécifie les flags du compilateur
CXXFLAGS = -Wall -O2 --std=c++17

# Cible par défaut (quand on tape 'make' tout seul)
all: mon_programme

# Règle pour construire mon_programme
mon_programme: mon_programme.cpp
	echo "Compilation de mon_programme..."
	$(CXX) $(CXXFLAGS) mon_programme.cpp -o mon_programme.exe

# Règle pour nettoyer les fichiers générés
clean:
	rm -f mon_programme

[%dynamic, cpp, compile="make", filename="mon_programme.cpp"]

#include <iostream>

int main()
{
	std::cout << "Hello, world!" << std::endl;
	return 0;
}