Merge branch 'leo/178-pos_static_lib' into 'master'

Integrated instrumentation: recognize positional static libraries on command line

Closes #178

See merge request eng/das/cov/gnatcoverage!359

gnatcov only used to recognize static libraries that were specified with the -l switch on link command lines. This change also makes it recognize \*.a files that are passed as positional arguments on the command line.

Fixes eng/das/cov/gnatcoverage#178

Author: leocreuse

testsuite/tests/integrated_instrumentation/cmake_lib/CMakeLists.txt

@@ -0,0 +1,9 @@
+project(HelloWorld)
+cmake_minimum_required(VERSION 3.0)
+
+# Create a static library from the sources in src
+add_library(my_lib STATIC src/lib.c)
+
+# Create an executable using the library previously declared
+add_executable(hello_world src/main.c)
+target_link_libraries(hello_world my_lib)

testsuite/tests/integrated_instrumentation/cmake_lib/src/lib.c

@@ -0,0 +1,7 @@
+#include "lib.h"
+
+int
+identity (int x)
+{
+  return x;
+}

testsuite/tests/integrated_instrumentation/cmake_lib/src/lib.h

@@ -0,0 +1,6 @@
+#ifndef LIB_H_
+#define LIB_H_
+
+int identity (int x);
+
+#endif // LIB_H_

testsuite/tests/integrated_instrumentation/cmake_lib/src/main.c

@@ -0,0 +1,10 @@
+#include <stdio.h>
+
+#include "lib.h"
+
+int
+main ()
+{
+  printf ("Hello world!\n");
+  return identity (0);
+}

testsuite/tests/integrated_instrumentation/cmake_lib/test.py

@@ -0,0 +1,60 @@
+"""
+Test that gnatcov correctly takes into account instrumented units present
+in a static library passed as a positional argument on the link command line.
+This is what is done by CMake when defining a library, then using it in an
+executable in the same CMakeLists.txt.
+"""
+
+import os
+import os.path
+
+from SUITE.control import env
+from SUITE.cutils import Wdir
+from SCOV.minicheck import check_xcov_reports
+from SUITE.tutils import cmdrun, srctracename_for, thistest, xcov
+
+Wdir("tmp_")
+
+cwd = os.getcwd()
+
+# Setup the instrumentation process
+xcov(
+    [
+        "setup-integration",
+        f"--files={os.path.join(cwd, '..', 'src', 'main.c')}",
+        f"--files={os.path.join(cwd, '..', 'src', 'lib.c')}",
+        "--compilers=gcc",
+    ]
+)
+
+# Shadow the compiler driver with the generated wrapper
+env.add_search_path(env_var="PATH", path=cwd)
+
+# Then, run the build process unchanged
+compiler_wrapper = os.path.join(cwd, 'gcc')
+cmdrun(["cmake", "..", f"-DCMAKE_C_COMPILER={compiler_wrapper}"], for_pgm=False)
+cmdrun(["make"], for_pgm=False)
+
+# Run the executable
+cmdrun(["hello_world"], for_pgm=True)
+
+# Check coverage expectations
+xcov(
+    [
+        "coverage",
+        "--level=stmt",
+        "--sid=main.c.sid",
+        "--sid=lib.c.sid",
+        "-axcov",
+        srctracename_for("main"),
+    ]
+)
+check_xcov_reports(
+    "*.xcov",
+    {
+        "main.c.xcov": {"+": {8, 9}},
+        "lib.c.xcov": {"+": {6}},
+    }
+)
+
+thistest.result()

tools/gnatcov/command_line.ads

@@ -1296,7 +1296,7 @@ package Command_Line is
                       | Cmd_Instrument_Main
                       | Cmd_Setup_Integration => True,
                       others                 => False),
-         Internal => True),
+         Internal => False),
 
       Opt_Shared_Object => Create
         (Long_Name   => "--shared-object",

tools/gnatcov/compiler_wrappers-gcc.adb

@@ -519,6 +519,8 @@ procedure Compiler_Wrappers.Gcc is
                else
                   Result.Object_Files.Append (Arg);
                end if;
+            elsif Ends_With (Arg, ".a") then
+               Result.Libraries.Append (Arg);
             end if;
          end;
       end loop;
@@ -631,17 +633,28 @@ procedure Compiler_Wrappers.Gcc is
             Ada.Environment_Variables.Value ("LIBRARY_PATH", ""));
 
          for Library of Command.Libraries loop
-            declare
-               use type GNAT.OS_Lib.String_Access;
-               Library_File : GNAT.OS_Lib.String_Access :=
-                 GNAT.OS_Lib.Locate_Regular_File
-                   ("lib" & (+Library) & ".a", +Library_Path);
-            begin
-               if Library_File /= null then
-                  Result.Union (Coverage_Buffer_Symbols (Library_File.all));
-                  GNAT.OS_Lib.Free (Library_File);
-               end if;
-            end;
+
+            if Ends_With (Library, ".a") then
+
+               --  Library filename on the command line, no need to look it up
+
+               Result.Union (Coverage_Buffer_Symbols (+Library));
+            else
+               --  Simple library name passed to the -l option, search the
+               --  actual file on the library path.
+
+               declare
+                  use type GNAT.OS_Lib.String_Access;
+                  Library_File : GNAT.OS_Lib.String_Access :=
+                    GNAT.OS_Lib.Locate_Regular_File
+                      ("lib" & (+Library) & ".a", +Library_Path);
+               begin
+                  if Library_File /= null then
+                     Result.Union (Coverage_Buffer_Symbols (Library_File.all));
+                     GNAT.OS_Lib.Free (Library_File);
+                  end if;
+               end;
+            end if;
          end loop;
       end;