Adding Python to the CI process

build/ci.yml

@@ -26,15 +26,27 @@ schedules:
     - main
   always: true
 
-pool:
-  vmImage: windows-latest
 
 jobs:
 - job: Build
   steps:
   - template: init.yml
   - template: steps.yml
   - template: wrap-up.yml
+  pool:
+    vmImage: windows-latest
+
+- job: LinuxBuild
+  steps:
+  - template: passes-linux.yml
+  pool:
+    vmImage: ubuntu-20.04
+
+- job: MacOSBuild
+  steps:
+  - template: passes-mac.yml
+  pool:
+    vmImage: macOS-latest
 
 - job: Style
   steps:
@@ -43,3 +55,5 @@ jobs:
 
   - script: dotnet tool run fantomas -- --check --recurse .
     displayName: Fantomas
+  pool:
+    vmImage: windows-latest

build/init.yml

@@ -31,3 +31,9 @@ steps:
   inputs:
     command: 'custom'
     customCommand: 'install -g npm@latest'
+
+- task: UsePythonVersion@0
+  inputs:
+    versionSpec: "3.9"
+    addToPath: true
+    architecture: "x64" 

build/passes-linux.yml

@@ -0,0 +1,14 @@
+
+steps:
+- script: |
+      sudo apt update -y
+      sudo apt install -y clang-11 cmake clang-format-11 clang-tidy-11 
+      sudo apt-get install -y llvm-11 lldb-11 llvm-11-dev libllvm11 llvm-11-runtime
+      export CC=clang-11
+      export CXX=clang++
+      cd src/Passes/
+
+      pip install -r requirements.txt
+      chmod +x manage
+      ./manage runci
+  displayName: Linux build and CI for passes      

build/passes-mac.yml

@@ -0,0 +1,19 @@
+
+steps:
+- script: |
+      brew install llvm@11
+      brew install cmake
+      brew install [email protected]
+      brew unlink [email protected] && brew link [email protected]
+
+      # Updating paths
+      export PATH="/usr/local/opt/python/libexec/bin:$PATH"
+      export PATH="/usr/local/opt/llvm@11/bin:$PATH"
+      export LDFLAGS="${LDFLAGS} -L/usr/local/opt/llvm@11/lib"
+      export CPPFLAGS="${CPPFLAGS} -I/usr/local/opt/llvm@11/include"
+
+      cd src/Passes/
+      pip install -r requirements.txt      
+      chmod +x manage
+      ./manage runci
+

build/passes-windows.ps1

@@ -0,0 +1,35 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+$ErrorActionPreference = 'Continue'
+
+python --version
+pip --version
+
+# Installing requirements for CI
+cd ../src/Passes/
+pip install -r requirements.txt
+
+
+
+# Installing Clang, CMake and LLVM
+if (!(Get-Command clang -ErrorAction SilentlyContinue)) {
+    & (Join-Path $env:CONDA scripts conda.exe) install -c conda-forge llvm-tools=11.1.0
+    & (Join-Path $env:CONDA scripts conda.exe) install -c conda-forge llvmdev=11.1.0
+}
+
+refreshenv
+$env:Path += ";C:\Miniconda\Library\LLVM\bin\"
+$env:LLVM = "C:\Miniconda\Library\LLVM\"
+
+cmd.exe /c "call `"C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat`" && set > %temp%\vcvars.txt"
+
+Get-Content "$env:temp\vcvars.txt" | Foreach-Object {
+  if ($_ -match "^(.*?)=(.*)$") {
+    Set-Content "env:\$($matches[1])" $matches[2]
+  }
+}
+
+
+# Running CI
+python manage runci

build/steps.yml

@@ -1,4 +1,10 @@
 steps:
+# Windows CI is disabled until we have a fully working 
+# configuration of LLVM with CMake
+# - pwsh: ./passes-windows.ps1
+#   displayName: "Passes style, build & test"
+#   workingDirectory: $(System.DefaultWorkingDirectory)/build
+
 - pwsh: ./build.ps1
   displayName: "Build all"
   workingDirectory: $(System.DefaultWorkingDirectory)/build

build/test.ps1

@@ -38,6 +38,7 @@ function Test-One {
     }
 }
 
+
 Test-One '../QsCompiler.sln'
 Test-One '../QsFmt.sln'
 

src/Passes/CMakeLists.txt

@@ -1,8 +1,15 @@
 cmake_minimum_required(VERSION 3.4.3)
 
-project(QSharpPasses)
+project(Passes)
+
+if (WIN32)
+  message(STATUS "Adding C:\\Program Files\\LLVM\\lib to LLVM paths")
+  find_package(LLVM REQUIRED PATHS "C:\\Program Files\\LLVM\\lib" CONFIG )
+else()
+  find_package(LLVM REQUIRED CONFIG)
+endif()
+
 
-find_package(LLVM REQUIRED CONFIG)
 include(CheckCXXCompilerFlag)
 
 message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
@@ -25,14 +32,6 @@ if(NOT LLVM_ENABLE_RTTI)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-rtti")
 endif()
 
-# -fvisibility-inlines-hidden is set when building LLVM and on Darwin warnings
-# are triggered if llvm-tutor is built without this flag (though otherwise it
-# builds fine). For consistency, add it here too.
-check_cxx_compiler_flag("-fvisibility-inlines-hidden" SUPPORTS_FVISIBILITY_INLINES_HIDDEN_FLAG)
-if (${SUPPORTS_FVISIBILITY_INLINES_HIDDEN_FLAG} EQUAL "1")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility-inlines-hidden")
-endif()
-
 # We export the compile commands which are needed by clang-tidy 
 # to run the static analysis
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

src/Passes/libs/ExpandStaticAllocation/LibExpandStaticAllocation.cpp

@@ -15,23 +15,19 @@ llvm::PassPluginLibraryInfo getExpandStaticAllocationPluginInfo()
     using namespace microsoft::quantum;
     using namespace llvm;
 
-    return {
-        LLVM_PLUGIN_API_VERSION, "ExpandStaticAllocation", LLVM_VERSION_STRING,
-        [](PassBuilder& pb)
-        {
-            // Registering the pass
-            pb.registerPipelineParsingCallback(
-                [](StringRef name, FunctionPassManager& fpm, ArrayRef<PassBuilder::PipelineElement> /*unused*/)
-                {
-                    if (name == "expand-static-allocation")
-                    {
-                        fpm.addPass(ExpandStaticAllocationPass());
-                        return true;
-                    }
+    return {LLVM_PLUGIN_API_VERSION, "ExpandStaticAllocation", LLVM_VERSION_STRING, [](PassBuilder& pb) {
+                // Registering the pass
+                pb.registerPipelineParsingCallback(
+                    [](StringRef name, FunctionPassManager& fpm, ArrayRef<PassBuilder::PipelineElement> /*unused*/) {
+                        if (name == "expand-static-allocation")
+                        {
+                            fpm.addPass(ExpandStaticAllocationPass());
+                            return true;
+                        }
 
-                    return false;
-                });
-        }};
+                        return false;
+                    });
+            }};
 }
 } // namespace
 

src/Passes/libs/OpsCounter/LibOpsCounter.cpp

@@ -16,30 +16,27 @@ llvm::PassPluginLibraryInfo getOpsCounterPluginInfo()
     using namespace microsoft::quantum;
     using namespace llvm;
 
-    return {
-        LLVM_PLUGIN_API_VERSION, "OpsCounter", LLVM_VERSION_STRING,
-        [](PassBuilder& pb)
-        {
-            // Registering the printer
-            pb.registerPipelineParsingCallback(
-                [](StringRef name, FunctionPassManager& fpm, ArrayRef<PassBuilder::PipelineElement> /*unused*/)
-                {
-                    if (name == "print<operation-counter>")
-                    {
+    return {LLVM_PLUGIN_API_VERSION, "OpsCounter", LLVM_VERSION_STRING, [](PassBuilder& pb) {
+                // Registering the printer
+                pb.registerPipelineParsingCallback(
+                    [](StringRef name, FunctionPassManager& fpm, ArrayRef<PassBuilder::PipelineElement> /*unused*/) {
+                        if (name == "print<operation-counter>")
+                        {
+                            fpm.addPass(OpsCounterPrinter(llvm::errs()));
+                            return true;
+                        }
+                        return false;
+                    });
+
+                pb.registerVectorizerStartEPCallback(
+                    [](llvm::FunctionPassManager& fpm, llvm::PassBuilder::OptimizationLevel /*level*/) {
                         fpm.addPass(OpsCounterPrinter(llvm::errs()));
-                        return true;
-                    }
-                    return false;
-                });
-
-            pb.registerVectorizerStartEPCallback(
-                [](llvm::FunctionPassManager& fpm, llvm::PassBuilder::OptimizationLevel /*level*/)
-                { fpm.addPass(OpsCounterPrinter(llvm::errs())); });
-
-            // Registering the analysis module
-            pb.registerAnalysisRegistrationCallback([](FunctionAnalysisManager& fam)
-                                                    { fam.registerPass([] { return OpsCounterAnalytics(); }); });
-        }};
+                    });
+
+                // Registering the analysis module
+                pb.registerAnalysisRegistrationCallback(
+                    [](FunctionAnalysisManager& fam) { fam.registerPass([] { return OpsCounterAnalytics(); }); });
+            }};
 }
 
 } // namespace

src/Passes/libs/OpsCounter/OpsCounter.cpp

@@ -21,10 +21,14 @@ namespace quantum
         {
             for (auto& instruction : basic_block)
             {
+                /*
+                TODO(tfr): Enable this block once we upgrade to LLVM 12 or above
                 if (instruction.isDebugOrPseudoInst())
                 {
                     continue;
                 }
+                */
+
                 auto name = instruction.getOpcodeName();
 
                 if (opcode_map.find(name) == opcode_map.end())

src/Passes/libs/QubitAllocationAnalysis/LibQubitAllocationAnalysis.cpp

@@ -16,31 +16,28 @@ llvm::PassPluginLibraryInfo getQubitAllocationAnalysisPluginInfo()
     using namespace microsoft::quantum;
     using namespace llvm;
 
-    return {
-        LLVM_PLUGIN_API_VERSION, "QubitAllocationAnalysis", LLVM_VERSION_STRING,
-        [](PassBuilder& pb)
-        {
-            // Registering a printer for the anaylsis
-            pb.registerPipelineParsingCallback(
-                [](StringRef name, FunctionPassManager& fpm, ArrayRef<PassBuilder::PipelineElement> /*unused*/)
-                {
-                    if (name == "print<qubit-allocation-analysis>")
-                    {
+    return {LLVM_PLUGIN_API_VERSION, "QubitAllocationAnalysis", LLVM_VERSION_STRING, [](PassBuilder& pb) {
+                // Registering a printer for the anaylsis
+                pb.registerPipelineParsingCallback(
+                    [](StringRef name, FunctionPassManager& fpm, ArrayRef<PassBuilder::PipelineElement> /*unused*/) {
+                        if (name == "print<qubit-allocation-analysis>")
+                        {
+                            fpm.addPass(QubitAllocationAnalysisPrinter(llvm::errs()));
+                            return true;
+                        }
+                        return false;
+                    });
+
+                pb.registerVectorizerStartEPCallback(
+                    [](llvm::FunctionPassManager& fpm, llvm::PassBuilder::OptimizationLevel /*level*/) {
                         fpm.addPass(QubitAllocationAnalysisPrinter(llvm::errs()));
-                        return true;
-                    }
-                    return false;
-                });
-
-            pb.registerVectorizerStartEPCallback(
-                [](llvm::FunctionPassManager& fpm, llvm::PassBuilder::OptimizationLevel /*level*/)
-                { fpm.addPass(QubitAllocationAnalysisPrinter(llvm::errs())); });
+                    });
 
-            // Registering the analysis module
-            pb.registerAnalysisRegistrationCallback(
-                [](FunctionAnalysisManager& fam)
-                { fam.registerPass([] { return QubitAllocationAnalysisAnalytics(); }); });
-        }};
+                // Registering the analysis module
+                pb.registerAnalysisRegistrationCallback([](FunctionAnalysisManager& fam) {
+                    fam.registerPass([] { return QubitAllocationAnalysisAnalytics(); });
+                });
+            }};
 }
 
 } // namespace

src/Passes/libs/QubitAllocationAnalysis/QubitAllocationAnalysis.cpp

@@ -65,10 +65,13 @@ namespace quantum
     void QubitAllocationAnalysisAnalytics::analyseCall(Instruction& instruction)
     {
         // Skipping debug code
+        /*
+        TODO(tfr): enable in LLVM12
         if (instruction.isDebugOrPseudoInst())
         {
             return;
         }
+        */
 
         // Recovering the call information
         auto* call_instr = llvm::dyn_cast<llvm::CallBase>(&instruction);

src/Passes/site-packages/TasksCI/formatting.py

@@ -10,6 +10,7 @@
 from .settings import PROJECT_ROOT
 from .toolchain import discover_formatter
 from typing import Union, List, Callable
+import difflib
 
 OptionalInt = Union[int, None]
 OptionalStr = Union[str, None]
@@ -91,8 +92,10 @@ def enforce_formatting(filename: str, contents: str, cursor: int, fix_issues: bo
             with open(filename, "w") as filebuffer:
                 filebuffer.write(formatted)
             return cursor, False
-
-        logger.error("{} was not correctly formatted.".format(filename))
+        else:
+            logger.error("{} was not correctly formatted.".format(filename))
+            sys.stdout.writelines(difflib.unified_diff(contents, formatted,
+                                                       fromfile=filename, tofile="formatted_{}".format(filename)))
         return cursor, True
 
     return cursor, False