How to integrate the RKTracer tool with Keil uvision/MDK-ARM IDE and generate code coverage?
How to integrate the RKTracer tool with Keil uvision/MDK-ARM IDE?
Code Coverage for Keil uVision
In a 3mins video you will see how to generate code coverage for applications in Keil uVision using the RKTracer tool with 3 simple steps.
Step 1: Ensure you have closed the Keil uvision IDE. Open a new command prompt and execute the following command to integrate the RKTracer tool with Keil uvision IDE.
rktracer -keil -integrate
Step 2: Open Keil uvision IDE, and you should be able to see RKTracer tool options in the Tools menu.
- RKTracer ON: Will enable RKTracer tool for instrumentation
- RKTracer OFF: Will disable RKTracer tool.
- RKTracer Reports: Will generate reports in HTML format.
Generate Code Coverage for Application in Keil uvision IDE?
Once you have successfully integrated the RKTracer tool. Atleast once you need to build and test the application in embedded target in debug mode.
Step 1: Enable RKTracer Tool
Goto → Tools → RKTracer ON. When you enable RKTracer Tool for the first time, you might get a popup to grant read/write permission for Keil uvision IDE.
Step 2: Rebuild the application and run tests on an embedded target.
Automatically coverage data will be saved when you terminate debug process after running the test case on the embedded target.
Once testing is complete, you can go to Toolbox settings options as shown in the following screenshot and select RKTracer dump() to save the code coverage data.
In case you have not connected to the embedded target device at the time of testing. You need to save the code coverage data from the RKTracer variable to the Host machine using APIs.
Step 3: Generate RKTracer Code Coverage Reports
Go to –> Tools menu –> RKTracer Report.
To generate Html reports.RKTracer tool will internally convert the RK_MEM.raw data file to “rk-coverage.txt” and map with JSON files (generated during instrumentation) in the rktracer folder and generate the HTML reports. You can manually open the HTML report using index.html.
Code Coverage Reports.
RKTracer HTML report landing page.
Code Coverage at the source code level.
Generate code coverage for selected functions/files/folder
Generate coverage reports for the selected folders
Suppose you need code coverage for source files from three different folders, i.e., core, keys, power, and ignore coverage for folders firmware_loader and lockdown. Edit rktracer.config in the RKTracer installation folder and go to the end of the file add the following information.
instrument */power/* */core/* */keys/*
never */firmware_loader/* */lockdown/*
ignore *.c = Ignores all C source files from instrumentation
Instrument = Instrument source files from given folders
never = ignore selected folder
Generate coverage reports only for selected functions from three different files.
fun_X() in source-file-X
fun_Y() in source-file-Y
fun_Z() in source-file-Z
Suppose you need code coverage for selected functions from three different files. Edit rktracer.config in the RKTracer installation folder and go to the end of the file and set the following variables as shown below.
instrument *source-file-X.c *source-file-Y.c *source-file-Z.c
function-instrument fun_X() fun_Y() fun_Z()
ignore *.c = Ignore all C programming source files
instrument *file-X.c *file-Y.c *file-Z.c = Instrument only these three source files.
function-ignore * = Then ignore all functions in the above three files.
function-instrument fun_X() fun_Y() fun_Z() = Don’t ignore these three functions from these three files from instrumentation.