Main Content

Configure CMake Build Process

CMake is a third-party, open-source tool for build process management. To build code generated from Simulink® models, the software provides CMake toolchain definitions for:

  • Microsoft® Visual C++® and MinGW® on Windows®, GCC on Linux®, and Xcode on Mac computers, using Ninja and makefile generators.

  • Microsoft Visual Studio® and Xcode project builds.

If a supported toolchain is installed on your development computer, you can specify the corresponding CMake toolchain definition for your model. When you run slbuild, press Ctrl+B, or run a software-in-the-loop (SIL), processor-in-the-loop (PIL), or external mode simulation, CMake:

  1. Uses configuration (CMakeLists.txt) files to generate standard build files.

  2. Runs the compiler and other build tools to create executable code.

You can also:

Specify CMake Toolchain Definition

In the Configuration Parameters dialog box:

  1. On the Hardware Implementation pane, specify parameter values for your target device, which determines the selection of toolchain definitions that is available. For more information, see Available CMake Toolchain Definitions.

  2. On the Code Generation pane, specify these parameters:

    • Toolchain — From the drop-down list, select a CMake toolchain definition.

    • Build configuration — Select one of these values:

      • Release — Optimizations enabled.

      • Debug — Optimizations disabled, debug symbols generated.

      • RelWithDebInfo — Optimizations enabled, debug symbols generated.

      • MinSizeRel — Optimized for size, debug symbols not generated.

      • Specify — Enables you to specify toolchain details through the CMake Configure and CMake Build fields.

    • Toolchain details — If Build configuration is Specify, populate these fields:

      • CMake Configure — Additional command-line arguments to pass to CMake when generating the project build system builder artifacts for the downstream tools.

      • CMake Build — Additional command-line arguments to pass to CMake when using it in build mode.

For more information, see https://cmake.org/cmake/help/latest/manual/cmake.1.html.

Available CMake Toolchain Definitions

PlatformShipped Toolchain DefinitionDevice Vendor and Type that Make Definition Available
WindowsMicrosoft Visual C++ 2017 v15.0 | CMake/nmake (64-bit Windows)

Intel-x86-64 (Windows64)

AMD-x86-64 (Windows64)

Microsoft Visual C++ 2017 v15.0 | CMake/Ninja (64-bit Windows)
Microsoft Visual Studio Project 2017 | CMake (64-bit Windows)
Microsoft Visual Studio Project 2019 | CMake (64-bit Windows)
Microsoft Visual C++ 2019 v16.0 | CMake/Ninja (64-bit Windows)
Microsoft Visual C++ 2022 v17.0 | CMake/nmake (64-bit Windows)
Microsoft Visual C++ 2022 v17.0 | CMake/Ninja (64-bit Windows)
MinGW64 | CMake/gmake (64-bit Windows)
MinGW64 | CMake/Ninja (64-bit Windows)
Microsoft Visual C++ 2017 v15.0 | CMake/nmake (32-bit Windows)

Intel-x86-32 (Windows32)

AMD-x86-32 (Windows32)

Microsoft Visual C++ 2017 v15.0 | CMake/Ninja (32-bit Windows)
Microsoft Visual Studio Project 2017 | CMake (32-bit Windows)
Microsoft Visual Studio Project 2019 | CMake (32-bit Windows)
Microsoft Visual C++ 2019 v16.0 | CMake/nmake (32-bit Windows)
Microsoft Visual C++ 2019 v16.0 | CMake/Ninja (32-bit Windows)
Microsoft Visual C++ 2022 v17.0 | CMake/nmake (32-bit Windows)
Microsoft Visual C++ 2022 v17.0 | CMake/Ninja (32-bit Windows)
LinuxGNU gcc/g++ | CMake/gmake (64-bit Linux)

Intel-x86-64 (Linux 64)

AMD-x86-64 (Linux 64)

GNU gcc/g++ | CMake/Ninja (64-bit Linux)
MacXcode with Clang | CMake/gmake (64-bit Mac)

Intel-x86-64 (Mac OS X)

AMD-x86-64 (Mac OS X)

Xcode with Clang | CMake/Ninja (64-bit Mac)
Xcode with Clang Project | CMake (64-bit Mac)

Note

If the Test hardware is the same as production hardware check box is not selected, the Test hardware settings for device vendor and type control the availability of shipped toolchain definitions.

Generate Only Code and CMake Configuration File for Algorithm Export

To export generated code to another development environment, use this workflow:

  1. In the Configuration Parameters dialog box, from the Toolchain drop-down list, select CMake. For this option, the code generator:

    • Generates C and C++ source code from the Simulink model but does not build the code.

    • Creates a CMake configuration (CMakeLists.txt) file that does not depend on specific build tools.

  2. Select the Package code and artifacts check box.

  3. Generate code, which produces a ZIP file that contains the source code and CMake configuration file.

  4. Relocate the ZIP file to your development environment.

  5. Unzip the packaged files.

  6. Use the CMake build tool and configuration file to create an executable file.

If the ZIP file contains mlrFiles.zip, static dependencies from your matlabroot folder tree, you must specify the location of the unzipped files for the CMake build tool. In your development environment, set the MATLAB_ROOT CMake cache entry by running this command:

cmake -S pathToSource -B pathToProposedLocationOfDerivedFiles 
-DMATLAB_ROOT=pathToUnzippedmlrFiles

For more information, see Deploy Component Algorithm as Component Model Library by Using CMake (Embedded Coder).

See Also

| |

Related Topics

External Websites