Qubit Allocation Analysis Pass

src/Passes/.clang-tidy

@@ -66,11 +66,23 @@ CheckOptions:
   - key:    readability-identifier-naming.ProtectedMemberSuffix
     value:  '_'        
 
-  # Alias
+  # Type Alias and Enum Types / constants
   - key:    readability-identifier-naming.TypeAliasCase
     value:  'CamelCase'
   - key:    readability-identifier-naming.TypedefCase
     value:  'CamelCase'
+  - key:    readability-identifier-naming.EnumCase
+    value:  'CamelCase'
+  - key:    readability-identifier-naming.EnumConstantCase
+    value:  'CamelCase'
+
+  # Globals, consts and enums
+  - key:    readability-identifier-naming.GlobalConstantCase
+    value:  'UPPER_CASE'
+  - key:    readability-identifier-naming.GlobalConstantPrefix
+    value:  'G_'
+  - key:    readability-identifier-naming.ConstantCase
+    value: 'UPPER_CASE'
 
   # Functions
   - key:    readability-identifier-naming.FunctionCase
@@ -86,18 +98,6 @@ CheckOptions:
   - key:    readability-identifier-naming.ParameterCase
     value:  'lower_case'
 
-  # Globals, consts and enums
-  - key:    readability-identifier-naming.GlobalConstantCase
-    value:  'UPPER_CASE'
-  - key:    readability-identifier-naming.GlobalConstantPrefix
-    value:  'G_'
-  - key:    readability-identifier-naming.ConstantCase
-    value: 'UPPER_CASE'
-  - key:    readability-identifier-naming.EnumCase
-    value:  'CamelCase'
-  - key:    readability-identifier-naming.EnumConstantCase
-    value:  'CamelCase'
-
   # Macros
   - key:    readability-identifier-naming.MacroDefinitionCase
     value:  'UPPER_CASE'

src/Passes/CMakeLists.txt

@@ -46,3 +46,4 @@ include_directories(${CMAKE_SOURCE_DIR}/src)
 
 # Adding the libraries
 add_subdirectory(libs)
+add_subdirectory(tests)

src/Passes/CONTRIBUTING.md

@@ -59,7 +59,7 @@ Prefer `#pragma once` over `#ifdef` protection.
 ## Code TODOs must contain owner name or Github issue
 
 ```sh
-% ./manage runci
+./manage runci
 (...)
 Passes/src/OpsCounter/OpsCounter.cpp:39:21: error: missing username/bug in TODO [google-readability-todo,-warnings-as-errors]
                     // TODO: Fails to load if this is present

src/Passes/Makefile

@@ -4,3 +4,4 @@ nothing:
 clean:
 	rm -rf Release/
 	rm -rf Debug/
+

src/Passes/README.md

@@ -185,7 +185,7 @@ and then make your target
 make [target]
 ```
 
-Valid targets are the name of the folders in `libs/` found in the passes root.
+The default target is `all`. Other valid targets are the name of the folders in `libs/` found in the passes root.
 
 ## Running a pass
 
@@ -204,7 +204,7 @@ For a detailed tutorial, see examples.
 To make it easy to create a new pass, we have created a few templates to get you started quickly:
 
 ```sh
-% ./manage create-pass HelloWorld
+./manage create-pass HelloWorld
 Available templates:
 
 1. Function Pass
@@ -215,17 +215,17 @@ Select a template:1
 At the moment you only have one choice which is a function pass. Over time we will add additional templates. Once you have instantiated your template, you are ready to build it:
 
 ```sh
-% mkdir Debug
-% cd Debug
-% cmake ..
+mkdir Debug
+cd Debug
+cmake ..
 -- The C compiler identification is AppleClang 12.0.5.12050022
 -- The CXX compiler identification is AppleClang 12.0.5.12050022
 (...)
 -- Configuring done
 -- Generating done
 -- Build files have been written to: ./qsharp-compiler/src/Passes/Debug
 
-% make
+make
 
 [ 25%] Building CXX object libs/CMakeFiles/OpsCounter.dir/OpsCounter/OpsCounter.cpp.o
 [ 50%] Linking CXX shared library libOpsCounter.dylib
@@ -240,9 +240,9 @@ template will not do much except for print the function names of your code. To t
 build an IR and run the pass:
 
 ```sh
-% cd ../examples/ClassicalIrCommandline
-% make
-% opt -load-pass-plugin ../../Debug/libs/libHelloWorld.{dylib,so} --passes="hello-world" -disable-output classical-program.ll
+cd ../examples/ClassicalIrCommandline
+make
+opt -load-pass-plugin ../../Debug/libs/libHelloWorld.{dylib,so} --passes="hello-world" -disable-output classical-program.ll
 ```
 
 If everything worked, you should see output like this:
@@ -303,7 +303,7 @@ that you use a docker image to perform these steps. TODO(TFR): The docker image
 One error that you may encounter is that an analysis pass does not load with output similar to this:
 
 ```sh
-% opt -load-pass-plugin ../../Debug/libQSharpPasses.dylib -enable-debugify  --passes="operation-counter" -disable-output   classical-program.bc
+opt -load-pass-plugin ../../Debug/libQSharpPasses.dylib -enable-debugify  --passes="operation-counter" -disable-output   classical-program.bc
 Failed to load passes from '../../Debug/libQSharpPasses.dylib'. Request ignored.
 opt: unknown pass name 'operation-counter'
 ```

src/Passes/docs/continous-integration.md

@@ -0,0 +1,105 @@
+# Running tests
+
+In order to run the tests, you first need to build the library. Assuming that this is already done and the corresponding build is in `Debug/`, run the tests from the `Debug` folder:
+
+```
+lit tests/ -v
+-- Testing: 2 tests, 2 workers --
+PASS: Quantum-Passes :: QubitAllocationAnalysis/case1.ll (1 of 2)
+PASS: Quantum-Passes :: QubitAllocationAnalysis/case2.ll (2 of 2)
+
+Testing Time: 0.27s
+  Passed: 2
+```
+
+# Continuous integration
+
+This component is the largest part of this PR. The continuous integration component includes:
+
+1. Style formatting to ensure that everything looks the same. This includes checking that relevant copyrights are in place.
+2. Static analysis
+3. Unit testing
+
+The automatic style enforcement is configurable with the ability to easily add or remove rules. Currently the source pipelines are defined as:
+
+```python
+SOURCE_PIPELINES = [
+    {
+        "name": "C++ Main",
+        "src": path.join(PROJECT_ROOT, "libs"),
+
+        "pipelines": {
+            "hpp": [
+                require_pragma_once,
+                enforce_cpp_license,
+                enforce_formatting
+            ],
+            "cpp": [
+                enforce_cpp_license,
+                enforce_formatting
+            ]
+        }
+    },
+    # ...
+]
+```
+
+This part defines pipelines for `.hpp` files and `.cpp` files allowing the developer to add such requirements such as having copyright in the op of the source file and ensure that formatting follows that given by `.clang-format`.
+
+Each of these CI stages can executed individually using `./manage` or you can run the entire CI process by invoking `./manage runci`. An example of what this may look like is here:
+
+```zsh
+./manage runci
+
+2021-07-21 14:38:04,896 - FormatChecker - ERROR - /Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/src/OpsCounter/OpsCounter.cpp was not correctly formatted.
+2021-07-21 14:38:04,899 - FormatChecker - ERROR - Your code did not pass formatting.
+
+./manage stylecheck --fix-issues
+./manage runci
+
+-- Found LLVM 11.1.0
+-- Using LLVMConfig.cmake in: /usr/local/opt/llvm@11/lib/cmake/llvm
+-- Configuring done
+-- Generating done
+-- Build files have been written to: /Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/Debug
+Consolidate compiler generated dependencies of target QSharpPasses
+[ 50%] Building CXX object CMakeFiles/QSharpPasses.dir/src/OpsCounter/OpsCounter.cpp.o
+[100%] Linking CXX shared library libQSharpPasses.dylib
+ld: warning: directory not found for option '-L/usr/local/opt/llvm/lib'
+[100%] Built target QSharpPasses
+/Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/src/OpsCounter/OpsCounter.cpp:29:7: error: invalid case style for class 'LegacyOpsCounterPass' [readability-identifier-naming,-warnings-as-errors]
+class LegacyOpsCounterPass : public FunctionPass
+      ^~~~~~~~~~~~~~~~~~~~
+      CLegacyOpsCounterPass
+113345 warnings generated.
+Suppressed 113345 warnings (113344 in non-user code, 1 NOLINT).
+Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
+1 warning treated as error
+2021-07-21 14:38:40,191 - Linter - ERROR - /Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/src/OpsCounter/OpsCounter.cpp failed static analysis
+
+# ISSUES FIXED MANUALLY
+./manage runci
+
+-- Found LLVM 11.1.0
+-- Using LLVMConfig.cmake in: /usr/local/opt/llvm@11/lib/cmake/llvm
+-- Configuring done
+-- Generating done
+-- Build files have been written to: /Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/Debug
+Consolidate compiler generated dependencies of target QSharpPasses
+[ 50%] Building CXX object CMakeFiles/QSharpPasses.dir/src/OpsCounter/OpsCounter.cpp.o
+[100%] Linking CXX shared library libQSharpPasses.dylib
+ld: warning: directory not found for option '-L/usr/local/opt/llvm/lib'
+[100%] Built target QSharpPasses
+-- Found LLVM 11.1.0
+-- Using LLVMConfig.cmake in: /usr/local/opt/llvm@11/lib/cmake/llvm
+-- Configuring done
+-- Generating done
+-- Build files have been written to: /Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/Debug
+Consolidate compiler generated dependencies of target QSharpPasses
+[100%] Built target QSharpPasses
+*********************************
+No test configuration file found!
+*********************************
+```
+
+The key idea here is to make it extremely easy to be complaint with the style guide, correct any issues that might come as a result of static analysis and at the same time enforce this when a PR is made.

src/Passes/docs/library-structure.md

@@ -0,0 +1,38 @@
+# Library structure for passes
+
+An important part of this PR is that it proposes a structure for passes: It is suggested that each pass has their own subcode base. The reason for this proposal is that it makes it very easy to add and remove passes as well as decide which passes to link against. Each pass is kept in its own subdirectory under `libs`:
+
+```
+libs
+├── CMakeLists.txt
+└── OpsCounter
+    ├── OpsCounter.cpp
+    └── OpsCounter.hpp
+```
+
+Adding a new pass is easy using the `manage` tool developed in this PR:
+
+```
+./manage create-pass HelloWorld
+Available templates:
+
+1. Function Pass
+
+Select a template:1
+```
+
+which results in a new pass code in the `libs`:
+
+```
+libs
+├── CMakeLists.txt
+├── HelloWorld
+│   ├── HelloWorld.cpp
+│   ├── HelloWorld.hpp
+│   └── SPECIFICATION.md
+└── OpsCounter
+    ├── OpsCounter.cpp
+    └── OpsCounter.hpp
+```
+
+A full example of how to create a basic function pass is included in the README.md file for anyone interested.

src/Passes/examples/ClassicalIrCommandline/README.md

@@ -8,13 +8,13 @@ IRs can be represented either by a human readible language or through bytecode.
 C programs former is generated by
 
 ```sh
-% clang -O1 -S -emit-llvm classical-program.c -o classical-program.ll
+  clang -O1 -S -emit-llvm classical-program.c -o classical-program.ll
 ```
 
 whereas the latter is generated by executing:
 
 ```sh
-% clang -O1 -c -emit-llvm classical-program.c -o classical-program.bc
+  clang -O1 -c -emit-llvm classical-program.c -o classical-program.bc
 ```
 
 This generates a nice and short IR which makes not too overwhelming to understand what is going on.
@@ -24,13 +24,13 @@ This generates a nice and short IR which makes not too overwhelming to understan
 This part assumes that you have built the Passes library.
 
 ```sh
-% opt -load ../../{Debug,Release}/libQSharpPasses.{dylib,so} -legacy-operation-counter -analyze classical-program.ll
+opt -load ../../{Debug,Release}/libQSharpPasses.{dylib,so} -legacy-operation-counter -analyze classical-program.ll
 ```
 
 ## Next-gen passes
 
 This part assumes that you have built the Passes library.
 
 ```sh
-% opt -load-pass-plugin ../../{Debug,Release}/libQSharpPasses.{dylib,so} --passes="operation-counter" -disable-output classical-program.bc
+opt -load-pass-plugin ../../{Debug,Release}/libs/libQSharpPasses.{dylib,so} --passes="print<operation-counter>" -disable-output classical-program.bc
 ```

src/Passes/examples/OptimisationUsingOpt/README.md

@@ -20,10 +20,10 @@ namespace Example {
 You find the code for this in the folder `SimpleExample`. To generate a QIR for this code, go to the folder and run
 
 ```sh
-% cd SimpleExample/
-% dotnet clean SimpleExample.csproj
+cd SimpleExample/
+dotnet clean SimpleExample.csproj
 (...)
-% dotnet build SimpleExample.csproj -c Debug
+dotnet build SimpleExample.csproj -c Debug
 ```
 
 If everything went well, you should now have a subdirectory called `qir` and inside `qir`, you will find `SimpleExample.ll`. Depending on your compiler,

src/Passes/examples/QubitAllocationAnalysis/ConstSizeArray/Comparison.cpp

@@ -0,0 +1,18 @@
+#include <vector>
+
+void QuantumFunction(int32_t nQubits)
+{
+  volatile uint64_t x = 3;
+  for (uint64_t i = 0; i < x; ++i)
+  {
+    nQubits += nQubits;
+  }
+  int32_t qubits[nQubits];
+}
+
+int main()
+{
+  QuantumFunction(10);
+  QuantumFunction(3);
+  return 0;
+}

src/Passes/examples/QubitAllocationAnalysis/ConstSizeArray/ConstSizeArray.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.Quantum.Sdk/0.18.2106148911">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <QirGeneration>true</QirGeneration>
+  </PropertyGroup>
+
+</Project>

src/Passes/examples/QubitAllocationAnalysis/ConstSizeArray/ConstSizeArray.qs

@@ -0,0 +1,30 @@
+namespace Example {
+    @EntryPoint()
+    operation Main() : Int
+    {
+
+        QuantumProgram(3,2,1);
+        QuantumProgram(4,X(2),4);
+        return 0;
+    }
+
+    function X(value: Int): Int
+    {
+        return 3 * value;
+    }
+
+    operation QuantumProgram(x: Int, h: Int, g: Int) : Unit {
+        let z = x * (x + 1) - 47;
+        let y = 3 * x;
+
+        use qubits0 = Qubit[9];
+        use qubits1 = Qubit[(y - 2)/2-z];
+        use qubits2 = Qubit[y - g];
+        use qubits3 = Qubit[h];
+        use qubits4 = Qubit[X(x)];
+
+        for idxIteration in 0..g {
+          //Message(idxIteration);
+        }        
+    }
+}

src/Passes/examples/QubitAllocationAnalysis/ConstSizeArray/Makefile

@@ -0,0 +1,13 @@
+analysis-example.ll:
+	dotnet build ConstSizeArray.csproj 
+	opt -S qir/ConstSizeArray.ll -O1  > ../analysis-example.ll  
+	make clean 
+
+comparison:
+	clang++ -S -emit-llvm -std=c++14 -stdlib=libc++ Comparison.cpp -o comparison.ll
+
+clean:
+	rm -rf bin
+	rm -rf obj
+	rm -rf qir
+