Merge branch 'leo/152-setup_shared' into 'master'

Do not build a shared version of gnatcov_rts if there is no shared Ada runtime available

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

We generally do not provide a shared version of the runtime for light runtimes, even though the platform might support it (native, qnx). As such, relying on the `Library_Support` attribute is not enough to determine whether we can actually build a shared `gnatcov_rts`. Instead, look for the presence of a shared Ada runtime to determine if we should attempt it.

Part of eng/das/cov/gnatcoverage#152

Author: leocreuse

testsuite/tests/152-shared_setup/main.adb

@@ -0,0 +1,6 @@
+with Ada.Text_IO; use Ada.Text_IO;
+
+procedure Main is
+begin
+   Put_Line ("Hello world!");
+end Main;

testsuite/tests/152-shared_setup/test.opt

@@ -0,0 +1 @@
+!native DEAD Test requires both shared lib support and available light runtime

testsuite/tests/152-shared_setup/test.py

@@ -0,0 +1,125 @@
+"""
+Check that "gnatcov setup" does not try to build a shared version of the
+coverage runtime when the Ada runtime is not available as a shared library.
+
+This is the case for all of our light runtimes: even though the platform might
+support them, we generally don't build the shared version of the runtime.
+"""
+
+import os
+
+from SCOV.instr import xcov_convert_base64, xcov_instrument
+from SCOV.minicheck import check_xcov_reports
+from SUITE.context import thistest
+from SUITE.control import env
+from SUITE.cutils import Wdir, contents_of
+from SUITE.tutils import (
+    exepath_to,
+    gprfor,
+    run_and_log,
+    run_cov_program,
+    xcov,
+)
+from SUITE.gprutils import GPRswitches
+
+tmp = Wdir("tmp_")
+
+# Name of the installed runtime project, to avoid conflict with the one setup
+# by the testing infrastructure.
+rt_prj = "rt_prj"
+
+# Installation directory for the instrumentation runtime project and directory
+# for the project path.
+rt_install_dir = os.path.abspath("install")
+rt_path_dir = os.path.join(rt_install_dir, "share", "gpr")
+
+prj = gprfor(
+    mains=["main.adb"],
+    objdir="obj",
+    srcdirs=[".."],
+    extra='   for Runtime ("Ada") use "light";',
+)
+
+gprsw = GPRswitches(root_project=prj)
+
+light_log = "setup_light.log"
+
+# Setup the coverage runtime for a light Ada runtime. Disable the automatic
+# passing of --config / --target / --rts as we are doing something custom.
+xcov(
+    [
+        "setup",
+        "--RTS=light",
+        f"--install-name={rt_prj}",
+        f"--prefix={rt_install_dir}",
+        "-v",
+    ],
+    out=light_log,
+    auto_target_args=False,
+    auto_config_args=False,
+)
+
+thistest.fail_if(
+    "Library support: STATIC_ONLY" not in contents_of(light_log),
+    "Incorrect library support for light runtime",
+)
+
+# Make this install available to GPR tools
+env.add_search_path("GPR_PROJECT_PATH", rt_path_dir)
+
+# As we want to override the config generated for the testsuite, we have to
+# manually re-do all the coverage workflow to ensure no "--config" argument is
+# used in the process.
+
+xcov_instrument(
+    gprsw,
+    covlevel="stmt",
+    dump_channel="base64-stdout",
+    dump_trigger="main-end",
+    runtime_project=rt_prj,
+    auto_config_args=False,
+    auto_target_args=False,
+)
+
+build_log = "gprbuild.log"
+
+p = run_and_log(
+    cmds=[
+        "gprbuild",
+        f"-P{prj}",
+        f"--implicit-with={rt_prj}",
+        "--src-subdirs=gnatcov-instr",
+    ],
+    output=build_log,
+    env=env.environ,
+)
+
+thistest.fail_if(p.status != 0, "GPRbuild exit in error")
+
+run_log = "run.log"
+
+# Ignore exit status as there's no way with a light runtime to set the exit
+# status to 0.
+run_cov_program(
+    exepath_to ("main"),
+    out=run_log,
+    register_failure=False,
+)
+
+main_srctrace = "main.srctrace"
+
+xcov_convert_base64(run_log, main_srctrace)
+
+xcov(
+    [
+        "coverage",
+        f"-P{prj}",
+        "-cstmt",
+        "-axcov",
+        main_srctrace,
+    ]
+)
+
+check_xcov_reports("*.xcov", {"main.adb.xcov": {"+": {5}}}, cwd="obj")
+
+thistest.result()

tools/gnatcov/setup_rts.adb

@@ -32,6 +32,7 @@ with GPR2.Containers;
 with GPR2.Log;
 with GPR2.Path_Name;
 with GPR2.Project.Attribute;
+with GPR2.Project.Attribute_Index;
 with GPR2.Project.Configuration;
 with GPR2.Project.Registry.Attribute;
 with GPR2.Project.Tree;
@@ -169,6 +170,11 @@ package body Setup_RTS is
    --  project to install. Use a filename that will match the Install'Artifacts
    --  attribute in the runtime project file.
 
+   function Has_Shared_Lib
+     (RTS_Dir : String; Shared_Lib_Ext : String) return Boolean;
+   --  Return whether there is any file with extension Shared_Lib_Ext in the
+   --  directory RTS_Dir/adalib.
+
    ------------------
    -- Load_Project --
    ------------------
@@ -491,23 +497,64 @@ package body Setup_RTS is
          end;
       end if;
 
-      --  Query the support for libraries in this configuration. When GPRconfig
-      --  fails to find the toolchain for the requested target/RTS, it only
-      --  emits warnings (no Invalid_Project exception raised in the call to
-      --  Load above). In this case, we reach this point and have an empty
-      --  string for the Library_Support attribute.
+      --  First, determine what kind of library is supported by the current
+      --  target / RTS configuration. If we have full library support, still
+      --  try to determine if we have access to a shared Ada runtime as it is
+      --  not always available.
+      --
+      --  To do this, we search in the <Runtime_Dir>/adalib directory any file
+      --  with a <Shared_Library_Suffix> extension. If we can't find anything
+      --  then assume only static libraries are supported.
+      --
+      --  If GPRconfig fails to find a toolchain, it only emits warnings (no
+      --  Invalid_Project exception raise in the call to Load above), so when
+      --  reaching this point, assume empty strings for all the attributes,
+      --  (and thus no library support).
 
       declare
-         Attr_Id : constant GPR2.Q_Attribute_Id :=
-           GPR2.Project.Registry.Attribute.Library_Support;
-         Attr    : constant GPR2.Project.Attribute.Object :=
-           Prj.Configuration.Corresponding_View.Attribute (Attr_Id);
-         LS      : constant String :=
-           (if Attr.Is_Defined
-            then String (Attr.Value.Text)
-            else "");
+         function Config_Attribute
+           (Id    : GPR2.Q_Attribute_Id;
+            Index : GPR2.Project.Attribute_Index.Object :=
+              GPR2.Project.Attribute_Index.Undefined) return String;
+         --  Return the string value for the attribute denoted by Id, at Index.
+         --  If the attribute value is not defined, return the empty string.
+
+         ----------------------
+         -- Config_Attribute --
+         ----------------------
+
+         function Config_Attribute
+           (Id    : GPR2.Q_Attribute_Id;
+            Index : GPR2.Project.Attribute_Index.Object :=
+              GPR2.Project.Attribute_Index.Undefined) return String
+         is
+            Attr : constant GPR2.Project.Attribute.Object :=
+              Prj.Configuration.Corresponding_View.Attribute (Id, Index);
+         begin
+            return (if Attr.Is_Defined then String (Attr.Value.Text) else "");
+         end Config_Attribute;
+
+         Lib_Support_Str : constant String :=
+           Config_Attribute (GPR2.Project.Registry.Attribute.Library_Support);
+
+         RTS_Dir : constant String :=
+           Config_Attribute
+             (GPR2.Project.Registry.Attribute.Runtime_Dir,
+              Index =>
+                GPR2.Project.Attribute_Index.Create (GPR2.Ada_Language));
+
+         Shared_Lib_Ext : constant String :=
+           Config_Attribute
+             (GPR2.Project.Registry.Attribute.Shared_Library_Suffix);
       begin
-         Lib_Support := Library_Support'Value (LS);
+         Lib_Support := Library_Support'Value (Lib_Support_Str);
+
+         if Lib_Support = Full
+           and then not Has_Shared_Lib (RTS_Dir, Shared_Lib_Ext)
+         then
+            Lib_Support := Static_Only;
+         end if;
+
       exception
          when Constraint_Error =>
             Fatal_Error ("Cannot get library support for this configuration");
@@ -1114,4 +1161,35 @@ package body Setup_RTS is
       return Had_Warnings;
    end Check_RTS_Profile;
 
+   --------------------
+   -- Has_Shared_Lib --
+   --------------------
+
+   function Has_Shared_Lib
+     (RTS_Dir : String; Shared_Lib_Ext : String) return Boolean
+   is
+      Lib_Dir_Search : Search_Type;
+   begin
+      if not Exists (RTS_Dir) then
+         return False;
+      end if;
+
+      Start_Search
+        (Lib_Dir_Search,
+         Directory =>
+         RTS_Dir & GNAT.OS_Lib.Directory_Separator & "adalib",
+         Pattern   => "*" & Shared_Lib_Ext,
+         Filter    =>
+           (Ordinary_File => True, others => False));
+
+      return Res : constant Boolean := More_Entries (Lib_Dir_Search) do
+         End_Search (Lib_Dir_Search);
+      end return;
+
+   exception
+      when Ada.Directories.Name_Error =>
+         End_Search (Lib_Dir_Search);
+         return False;
+   end Has_Shared_Lib;
+
 end Setup_RTS;

tools/gnatcov/subprocesses.adb

@@ -106,7 +106,11 @@ package body Subprocesses is
          if Success then
             Put_Line (Command & " finished");
          else
-            Error (Origin_Command_Name & " failed");
+            --  Do not use Error as this sets the exit status to Failure, but
+            --  here we are precisely ignoring the fact that the subprocess
+            --  failed.
+
+            Warning_Or_Error (Origin_Command_Name & " failed");
          end if;
       end if;
    end Check_Status;