Re-trying the PR #881: Migrating native sim from GCC to Clang. (#889)

* Re-trying the PR #881.
* Added copying libomp on Mac and Linux.
* Fixed the omp lib for Win.

Author: kuzminrobin

build/ci-codecheck.yml

@@ -27,7 +27,7 @@ jobs:
       linux:
         imageName: 'ubuntu-latest'
       mac:
-        imageName: 'macOS-10.15'
+        imageName: 'macOS-latest'
       #windows:                         # No sanitizers supported on Win at the moment.
       #  imageName: 'windows-latest'
   pool: 

build/ci.yml

@@ -31,7 +31,7 @@ jobs:
       linux:
         imageName: 'ubuntu-latest'
       mac:
-        imageName: 'macOS-10.15'
+        imageName: 'macOS-latest'
       windows:
         imageName: 'windows-latest'
   pool: 

build/steps-codecheck.yml

@@ -10,7 +10,7 @@ steps:
 
   # QIR Runtime:
 - pwsh: src/Qir/Runtime/prerequisites.ps1
-  displayName: "Install QIR Runtime Prerequisistes"
+  displayName: "Install QIR Runtime Prerequisites"
   workingDirectory: $(System.DefaultWorkingDirectory)
 
 - pwsh: src/Qir/Runtime/build-qir-runtime.ps1

src/Qir/Common/cmake/unit_test_include.cmake

@@ -9,7 +9,7 @@ macro(add_unit_test target)
     if(DEFINED ENV{NATIVE_SIMULATOR})
         set(TEST_DEPS1 $ENV{NATIVE_SIMULATOR})
     else()
-        set(TEST_DEPS1 "${PROJECT_SOURCE_DIR}/../../Simulation/native/build/$ENV{BUILD_CONFIGURATION}")
+        set(TEST_DEPS1 "${PROJECT_SOURCE_DIR}/../../Simulation/native/build/drop")
     endif()
 
     set(TEST_DEPS2 "${CMAKE_BINARY_DIR}/bin")

src/Qir/Runtime/lib/Simulators/FullstateSimulator.cpp

@@ -211,7 +211,7 @@ namespace Quantum
         {
             if (this->simulatorId != NULL_SIMULATORID)
             {
-                typedef unsigned (*TDestroy)(unsigned);
+                typedef void (*TDestroy)(unsigned);
                 static TDestroy destroySimulatorInstance =
                     reinterpret_cast<TDestroy>(LoadProc(this->handle, "destroy"));
                 assert(destroySimulatorInstance);
@@ -226,7 +226,7 @@ namespace Quantum
         // Deprecated, use `DumpMachine()` and `DumpRegister()` instead.
         void GetState(TGetStateCallback callback) override
         {
-            typedef bool (*TDump)(unsigned, TGetStateCallback);
+            typedef void (*TDump)(unsigned, TGetStateCallback);
             static TDump dump = reinterpret_cast<TDump>(this->GetProc("Dump"));
             dump(this->simulatorId, callback);
         }
@@ -462,7 +462,7 @@ namespace Quantum
 
         void R(PauliId axis, QubitIdType target, double theta) override
         {
-            typedef unsigned (*TR)(unsigned, unsigned, double, unsigned);
+            typedef void (*TR)(unsigned, unsigned, double, unsigned);
             static TR r = reinterpret_cast<TR>(this->GetProc("R"));
 
             r(this->simulatorId, GetBasis(axis), theta, GetQubitId(target));
@@ -472,7 +472,7 @@ namespace Quantum
         void ControlledR(long numControls, QubitIdType controls[], PauliId axis, QubitIdType target,
                          double theta) override
         {
-            typedef unsigned (*TMCR)(unsigned, unsigned, double, unsigned, unsigned*, unsigned);
+            typedef void (*TMCR)(unsigned, unsigned, double, unsigned, unsigned*, unsigned);
             static TMCR cr = reinterpret_cast<TMCR>(this->GetProc("MCR"));
 
             std::vector<unsigned> ids = GetQubitIds(numControls, controls);
@@ -483,7 +483,7 @@ namespace Quantum
 
         void Exp(long numTargets, PauliId paulis[], QubitIdType targets[], double theta) override
         {
-            typedef unsigned (*TExp)(unsigned, unsigned, unsigned*, double, unsigned*);
+            typedef void (*TExp)(unsigned, unsigned, unsigned*, double, unsigned*);
             static TExp exp                      = reinterpret_cast<TExp>(this->GetProc("Exp"));
             std::vector<unsigned> ids            = GetQubitIds(numTargets, targets);
             std::vector<unsigned> convertedBases = GetBases(numTargets, paulis);
@@ -494,7 +494,7 @@ namespace Quantum
         void ControlledExp(long numControls, QubitIdType controls[], long numTargets, PauliId paulis[],
                            QubitIdType targets[], double theta) override
         {
-            typedef unsigned (*TMCExp)(unsigned, unsigned, unsigned*, double, unsigned, unsigned*, unsigned*);
+            typedef void (*TMCExp)(unsigned, unsigned, unsigned*, double, unsigned, unsigned*, unsigned*);
             static TMCExp cexp                   = reinterpret_cast<TMCExp>(this->GetProc("MCExp"));
             std::vector<unsigned> idsTargets     = GetQubitIds(numTargets, targets);
             std::vector<unsigned> idsControls    = GetQubitIds(numControls, controls);

src/Qir/Runtime/public/QubitManager.hpp

@@ -40,7 +40,9 @@ namespace Quantum
         // No complex scenarios for now. Don't need to support copying/moving.
         CQubitManager(const CQubitManager&) = delete;
         CQubitManager& operator=(const CQubitManager&) = delete;
-        virtual ~CQubitManager();
+        ~CQubitManager(); // If this dtor is made _virtual_ then the QIR RT tests crash (at least in Debug config)
+                          // if the native simulator is compiled with Clang (as opposed to GCC). Nothing wrong found in
+                          // the code,  probably is the compiler bug.
 
         // Restricted reuse area control
         void StartRestrictedReuseArea();

src/Qir/Runtime/test-qir-runtime.ps1

@@ -3,8 +3,10 @@
 
 . (Join-Path $PSScriptRoot .. qir-utils.ps1)
 
-# TODO: `ASAN_OPTIONS=check_initialization_order=1` (https://clang.llvm.org/docs/AddressSanitizer.html#initialization-order-checking).
 # TODO: macOS: `ASAN_OPTIONS=detect_leaks=1` (https://clang.llvm.org/docs/AddressSanitizer.html#memory-leak-detection).
+$env:ASAN_OPTIONS = "check_initialization_order=true:detect_stack_use_after_return=true:" `
+    + "alloc_dealloc_mismatch=true:new_delete_type_mismatch=true:strict_init_order=true:strict_string_checks=true:" `
+    + "detect_invalid_pointer_pairs=2"
 
 if (-not (Test-CTest (Join-Path $PSScriptRoot bin $Env:BUILD_CONFIGURATION unittests) "QIR Runtime")) {
     throw "At least one project failed testing. Check the logs."

src/Qir/Samples/StandaloneInputReference/CMakeLists.txt

@@ -34,7 +34,7 @@ add_test(
 if(DEFINED ENV{NATIVE_SIMULATOR})
     set(TEST_DEPS1 $ENV{NATIVE_SIMULATOR})
 else()
-    set(TEST_DEPS1 "${PROJECT_SOURCE_DIR}/../../Simulation/native/build/$ENV{BUILD_CONFIGURATION}")
+    set(TEST_DEPS1 "${PROJECT_SOURCE_DIR}/../../Simulation/native/build/drop")
 endif()
 
 set(TEST_DEPS2 "${PROJECT_SOURCE_DIR}/../Runtime/bin/$ENV{BUILD_CONFIGURATION}/bin")

src/Qir/Samples/test-qir-samples.ps1

@@ -3,8 +3,10 @@
 
 . (Join-Path $PSScriptRoot .. qir-utils.ps1)
 
-# TODO: `ASAN_OPTIONS=check_initialization_order=1` (https://clang.llvm.org/docs/AddressSanitizer.html#initialization-order-checking).
 # TODO: macOS: `ASAN_OPTIONS=detect_leaks=1` (https://clang.llvm.org/docs/AddressSanitizer.html#memory-leak-detection).
+$env:ASAN_OPTIONS = "check_initialization_order=true:detect_stack_use_after_return=true:" `
+    + "alloc_dealloc_mismatch=true:new_delete_type_mismatch=true:strict_init_order=true:strict_string_checks=true:" `
+    + "detect_invalid_pointer_pairs=2"
 
 if (-not (Test-CTest (Join-Path $PSScriptRoot bin $Env:BUILD_CONFIGURATION StandaloneInputReference) "QIR Samples (StandaloneInputReference)")) {
     throw "At least one project failed testing. Check the logs."

src/Qir/Tests/test-qir-tests.ps1

@@ -16,14 +16,10 @@ if ($Env:BUILD_CONFIGURATION -eq "Debug")
     if (-not ($IsWindows))
     {
         $env:LSAN_OPTIONS += "suppressions=../../../../LSan.ignore"    # https://clang.llvm.org/docs/AddressSanitizer.html#suppressing-memory-leaks
-        if (-not ($IsMacOS))
-        {
-            $env:ASAN_OPTIONS += "check_initialization_order=1"    # https://clang.llvm.org/docs/AddressSanitizer.html#initialization-order-checking
-        }
-        #else    # AddressSanitizer: detect_leaks is not supported on this platform. Re-enable this once supported.
-        #{
-        #    $env:ASAN_OPTIONS += "detect_leaks=1"      # https://clang.llvm.org/docs/AddressSanitizer.html#memory-leak-detection
-        #}
+        # TODO: macOS: `ASAN_OPTIONS=detect_leaks=1` (https://clang.llvm.org/docs/AddressSanitizer.html#memory-leak-detection).
+        $env:ASAN_OPTIONS = "check_initialization_order=true:detect_stack_use_after_return=true:" `
+            + "alloc_dealloc_mismatch=true:new_delete_type_mismatch=true:strict_init_order=true:strict_string_checks=true"
+            # + ":detect_invalid_pointer_pairs=2" TODO(rokuzmin, #883): ==8218==ERROR: AddressSanitizer: invalid-pointer-pair: 0x602000000af4 0x602000000af0
     }
 }