#Visual studio code coverage settings how to#
#Visual studio code coverage settings install#
#Visual studio code coverage settings code#

Note that the coverage report will only include the functions in the instrumented files and the overall memory overhead will be much lower:

#Visual studio code coverage settings code#

Now select specific file(s) you want to instrument and enable the “Generate Code Coverage Reports” option for them:.

This will disable the instrumentation of all source files unless we override it for specific files: Note that the project-level setting configured in the previous step needs to be turned on.

Go to the C/C++->Instrumentation page of Visual Studio Project Properties and turn off the Generate Code Coverage Reports setting there.

Unless it is enabled, GCC will try to insert the function layout information for every function defined in the project (even the unused ones) into the final binary, quickly consuming most of the available RAM.

Make sure that the Instrument Code for Code Coverage setting is turned on: Enabling this setting turns on coverage information optimization by VisualGDB. Open Visual Studio Project Properties for the project itself and go to the Embedded Project page.

#Visual studio code coverage settings how to#

Now we will show how to reduce the memory overhead caused by the code coverage.

Note how the body of the other tests is now highlighted in red (the test declaration will be highlighted in green because it contains a static constructor):.

CHECK_EQUAL(1,1)) will be excluded from the coverage report by gcc in order to reduce the memory overhead. Note that the lines that could be resolved during compile time (e.g. As long as the coverage highlighting is enabled and you are using the Clang IntelliSense engine, the lines that were executed will be highlighted green and the lines that were never executed will be highlighted red.

When the tests finish running, open the Test->VisualGDB Code Coverage Reports window to display the code coverage from the latest run: The Code Coverage window will show statistics on the coverage of various functions in the project.

Open the Test Explorer window, right-click on the test project and select “Run Selected Tests”:.

We will show the exact setting responsible for this later in the tutorial. make sure you have enabled code coverage on the project level, not just in the C/C++->Instrumentation. Double-check that the build output contains the following line:ĭetached X coverage information blocks from Y object files Note that if instrumenting all code results in more than 100% overhead, the VisualGDB’s logic for trimming unnecessary coverage-related structures from the object files is likely not running. Note that the instrumented code will use more FLASH (due to extra instructions needed to track the executed functions and branches) and more RAM (due to the variables storing the function/branch counts): We will show how to reduce the overhead caused by the code coverage instrumentation later in this tutorial. Click “Yes” when VisualGDB asks whether you want to enable code instrumentation in the build settings: Enable the “build code coverage reports” checkbox and click “OK”.

Open VisualGDB Project Properties and go to the Code Coverage page.

Build it by pressing Ctrl-Shift-B and take a note of the FLASH/RAM use via the Embedded Memory Explorer window:

Press “OK” to generate a basic project.

If not, you can pick a debug method manually on the Debug Method page of the wizard:

Connect your JTAG debugger to the USB and make sure VisualGDB detects it.

Proceed with the default test project sample and click “Next” to continue to the next page:.

For most accurate code coverage results we advise using GCC 9.x or later:

On the next page select the toolchain and your device.

On the first page of the VisualGDB’s part of the wizard, select “Create a new project -> Unit test -> MSBuild -> TinyEmbeddedTest”:.

Specify the name and location for the project you are creating:.

Start Visual Studio and open the VisualGDB Embedded Project Wizard:.

#Visual studio code coverage settings install#

We will create a basic test project based on the TinyEmbeddedTest framework, will instrument it to produce code coverage reports at the end of the debug sessions and will show how to view the reports and reduce the memory overhead by controlling which files get instrumented.īefore you begin, install VisualGDB 5.5 or later.

This tutorial shows how to use VisualGDB to analyze the code coverage of embedded projects.