Polyspace in Jenkins. How to reduce the size of the generated options file?

We are using Polyspace with the automation server Jenkins. The method to generate automatically a Polyspace options_file, is to use the command Polyspace-configure.

The line, in the makefile, used to call the command is the following:

$(base_dir)/polyspace/bin/polyspace-configure -output-options-file $(generated_options)  -no-project make -B build -f linux.makefile

In Jenkinsfile, there is the command that calls a target of the makefile which contains the command polyspace-bug-finder-server. The polyspace-bug-finder-server has the generated options-file as input.

We can see that this generated file contains the command “-options-for-sources” for each file given as a source. Each line is very long because it contains a lot of inclusions and MACROs for each file. There are around 500 source files and for each file, there are about 200 “-I” inclusions and 100 of “-D” command for MACROS.

We think that these long lines cause slow execution of the Jenkins step when it uses the generated file (-options-file) with the bug finder analysis.

The same MACROs are in all the "-options-for-sources" lines. Many of the included folders are common with many "-options-for-sources".

Is there an option of polyspace-configure or other commands, that can help us to reduce the size of the generated file lines? I mean, to collect the common inclusions in a unique line for example.

Answer 1

[Anirban]

You can add the option -merge-common-options to the polyspace-configure line. This will take all the -options-for-sources arguments and put them in one pile (and remove the duplicates). However, there is a caveat: all the -options-for-sources arguments have to be the exact same for them to be merged into one pile.

This option usually works in a lot of contexts despite the caveat because all files to analyze are usually built with the same macro definitions and includes. Therefore, all -options-for-sources arguments might be just the same.

Differences between -options-for-sources arguments occur, for instance, when you build a project with files other than just the sources. For instance, you might be building test files, which then get added to the Polyspace options file (with -options-for-sources arguments that are different from the sources). In this case, you can use the options -exclude-sources/-include-sources to prevent unnecessary files from being added and also use -merge-common-options to merge all -options-for-sources arguments into one pile without duplicates. See polyspace-configure page for more information on the options.

[Alessandro Samori]

I inserted the option -merge-common-options in the line shown below:

$(base_dir)/polyspace/bin/polyspace-configure -output-options-file $(generated_options) -merge-common-options -no-project make -B build -f linux.makefile

However, the compiler provides the error that means it cannot find the option:

+ cd Build_Prj
+ make configure-build -f linux.makefile
/usr/local/Polyspace_Server/R2019b/polyspace/bin/polyspace-configure -output-options-file polyspace_options.txt -merge-common-options -no-project make -B build -f linux.makefile

polyspace-configure: 0s: ERROR: Could not recognize Option -merge-common-options
polyspace-configure: 0s: ERROR: Command line could not be processed

Is this error caused by my version of polyspace? (2019b) or is it caused by my wrong command line?

[Anirban]

You need R2021a or later to use this option.

[Alessandro Samori]

Ok understood.

The only way to reduce the lines in the -options-file is by doing this manually. How can I do this? Should I create a line in the polyspace -options-file?

For example: since the MACROs are the same for all the files, can I create a line where each MACRO is inserted with the command "-D" and a ";" to separate the MACROs?

Since I know where are the inclusion folders, is it possible to create one or more few lines where I put all the inclusion folders (for all the files) defined by the "-I" command and separated by ";" ? I mean, without putting all the files at the beginning as it is now with the command -options-for-sources (where there is a file.c and then all the inclusion folders and MACROs it needs).

Or do you want to propose another method to simplify the big generated file? Probably my solution is in contrast with the philosophy of Jenkins that is used to automate the process.

thanks

[Anirban]

You can contact MathWorks Technical Support to help you simplify the generated file. If all the macros are the same, it might make sense to add separate -D -s towards the beginning of the options file (one -D per line, no semicolon needed). The include folders are more difficult since the order of the include folders matters. MathWorks Technical Support can take a look at the options file you have currently and suggest solutions.