Resolve Coverity static analysis issues

[pcolberg]

The runtime project is transitioning from Klocwork to Coverity for static code analysis. This issue tracks the number of remaining Coverity issues on a semi-regular basis. The initial goal is to reduce the number of Coverity issues to zero and fail the Coverity workflow with a non-zero exit status on new issues. So far all Coverity issues could be addressed through reasonable code changes that fix potential bugs and/or improve code quality.

When updating this issue, attach a copy of the zip file from the Coverity workflow artifacts for archival, since artifacts are purged after some time.

To count issues, take the number of blank lines and divide by 2:

echo "scale=0; $(grep -c '^$' cov-errors.txt) / 2" | bc -l

[pcolberg]

The first Coverity run was for commit 09b560f with 161 issues.

[pcolberg]

Latest Coverity run for commit dd7c2cd has 99 issues.

[IlanTruanovsky]

To count issues, take the number of paragraphs and divide by 2:

The cov-analyze command that runs in the workflow provides detailed information regarding the number of defects.

I.e. for the first Coverity run: https://github.com/intel/fpga-runtime-for-opencl/actions/runs/3525211581/jobs/5913259883#step:9:53

Should we be using that instead?

[pcolberg]

To count issues, take the number of paragraphs and divide by 2:

The cov-analyze command that runs in the workflow provides detailed information regarding the number of defects.

I.e. for the first Coverity run: https://github.com/intel/fpga-runtime-for-opencl/actions/runs/3525211581/jobs/5913259883#step:9:53

Should we be using that instead?

No, unfortunately that does not provide the information we need. The statistics printed by cov-analyze include all Coverity issues, both those in the runtime code as well as those in system libraries that are outside of our control. cov-format-errors on the other hand allows filtering issues by prefix path, which is the count we need. I could not find a comparable option for cov-analyze.

While ideally all of the issues would be addressed, the scope of this project is resolving the Coverity issues in code we control. Besides, we have to keep in mind that some percentage of the Coverity issues might not be actual bugs; it's just that this project has (so far) chosen to address all of them as the simplest course of action (and a straight-forward way to improve code quality and readability). That is this project's choice though; other projects might see this differently, especially if they don't use Coverity themselves.

[pcolberg]

I am adding the count to the Coverity workflow; no point in doing that manually.

[pcolberg]

Latest Coverity run for 5a71e64 has 89 issues.

[pcolberg]

Latest Coverity run for 67e23e1 has 79 issues.

Summary by filename:

awk -v 'RS=\n\n' 'NR%2==1' cov-errors.txt | awk -F: 'NR%2==1 { print $1 }' | uniq -c

      2 lib/CppUTest/include/CppUTest/CommandLineTestRunner.h
      1 lib/CppUTest/include/CppUTest/SimpleString.h
      2 lib/CppUTest/include/CppUTest/TestRegistry.h
      2 lib/CppUTest/include/CppUTest/TestTestingFixture.h
      1 lib/CppUTest/src/CommandLineTestRunner.cpp
      1 lib/CppUTest/src/JUnitTestOutput.cpp
      4 lib/CppUTest/src/MemoryLeakDetector.cpp
      1 lib/CppUTest/src/MemoryLeakWarningPlugin.cpp
      1 lib/CppUTest/src/SimpleString.cpp
      1 lib/CppUTest/src/TestPlugin.cpp
      1 lib/CppUTest/test/MemoryLeakDetectorTest.cpp
      1 lib/CppUTest/test/PluginTest.cpp
      1 lib/CppUTest/test/SimpleStringTest.cpp
      2 lib/acl_threadsupport/test/acl_threadsupport_test.cpp
      2 lib/pkg_editor/src/pkg_editor.c
      6 lib/pkg_editor/test/pkg_editor_test.cpp
      4 src/acl_hal_mmd.cpp
      2 test/acl_context_test.cpp
      1 test/acl_globals_test.cpp
      2 test/acl_hal_test.cpp
      2 test/acl_kernel_test.cpp
     17 test/acl_mem_test.cpp
     12 test/acl_platform_test.cpp
      3 test/acl_profiler_test.cpp
      2 test/acl_program_test.cpp
      1 test/acl_svm_test.cpp
      3 test/acl_test.cpp
      1 test/acl_usm_test.cpp

Summary by component:

awk -v 'RS=\n\n' 'NR%2==1' cov-errors.txt | awk -F: 'NR%2==1 { print $1 }' | grep -oE '^(lib/[^/]+|src|test)' | uniq -c

     19 lib/CppUTest
      2 lib/acl_threadsupport
      8 lib/pkg_editor
      4 src
     46 test

A quarter of the remaining issues are in CppUTest, which has further issues beyond Coverity. @IlanTruanovsky, please ignore the CppUTest issues for now. We will need to come to a conclusion on how to proceed with CppUTest altogether, not just with regard to Coverity: whether to keep maintaining the in-tree fork with thread support, or to use an out-of-tree, unmodified upstream version and factor out the multi-threading test support into the unit tests.