Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.78 KB

compilation.rst

File metadata and controls

59 lines (40 loc) · 2.78 KB
Raw

Compilation Example

Hello World Example

In this section, we will show to compile source code with compiler and compiler flags. To get started, let's start with a simple hello world example we have available in C and C++ as shown below

../tutorials/compilation/hello.c

../tutorials/compilation/hello.cpp

Shown below is an example buildspec file that will compile the above source code with the gcc compiler. The compilers section is used to specify the compiler to use that is selected via the name property which applies a regular expression to search for compiler. The compilers are defined in buildtest configuration file see compilers for more details.

../tutorials/compilation/hello_world_compilation.yml

Buildtest will define environment variables like BUILDTEST_CC and BUILDTEST_CXX that point to the C and C++ compiler wrapper for the selected compiler.

Let's try to run the code and inspect the test output and test file.

buildtest build -b tutorials/compilation/hello_world_compilation.yml

buildtest build -b tutorials/compilation/hello_world_compilation.yml

buildtest inspect query -o -t hello_world_c_cpp

Please note that the compiler definition for builtin_gcc is a canonical name to reference to system GNU compiler that is set to /usr/bin/gcc, /usr/bin/g++. The compiler details can be extracted from the configuration file via buildtest config compilers list command. Shown below is the YAML output of the compiler details.

buildtest config compilers list --yaml

STREAM Benchmark Example

In this next section, we will run the STREAM memory benchmark. In order to run this example, we will need to download the source code and compile the source code. We will use the curl command to download the source code. The default section is used to specify default compiler settings for compiler, this may include compiler options and environment variables. The cflags option is responsible for setting C compiler flags which is set to environment variable BUILDTEST_CFLAGS that we can access in the run section. The env section is used to set environment variables that are used in the run section.

../tutorials/compilation/stream.yml

buildtest build -b tutorials/compilation/stream.yml

buildtest build -b tutorials/compilation/stream.yml

buildtest inspect query -o -t stream_openmp_c