Implement qir-qsim app for dynamic measurement handling

CMakeLists.txt

@@ -4,20 +4,21 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #----------------------------------------------------------------------------#
 
-cmake_minimum_required(VERSION 3.12)
+cmake_minimum_required(VERSION 3.18)
 
 # Set QIREE_VERSION using git tags using the following format
 set(CGV_TAG_REGEX "v([0-9.]+)(-dev|-rc.[0-9]+)?")
 include("${CMAKE_CURRENT_LIST_DIR}/cmake/CgvFindVersion.cmake")
 cgv_find_version(QIREE)
 
 project(QIREE VERSION "${QIREE_VERSION}" LANGUAGES CXX)
-cmake_policy(VERSION 3.12...3.22)
+cmake_policy(VERSION 3.18...3.30)
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
 include(GNUInstallDirs)
 include(CMakePackageConfigHelpers)
+include(FetchContent)
 include("${CMAKE_CURRENT_LIST_DIR}/cmake/QIREEUtils.cmake")
 
 macro(qiree_set_default name value)
@@ -34,9 +35,11 @@ endmacro()
 
 # Components
 option(QIREE_BUILD_DOCS "Build QIR-EE documentation" OFF)
-option(QIREE_BUILD_TESTS "Build QIR-EE unit tests" OFF)
+option(QIREE_BUILD_TESTS "Build QIR-EE unit tests" ON)
 option(QIREE_BUILD_EXAMPLES "Build QIR-EE examples" OFF)
+option(QIREE_USE_QSIM "Download and build Google qsim backend" OFF)
 option(QIREE_USE_XACC "Build XACC interface" ON)
+
 qiree_set_default(BUILD_TESTING ${QIREE_BUILD_TESTS})
 
 # Assertion handling
@@ -111,8 +114,28 @@ set(QIREE_RUNTIME_OUTPUT_DIRECTORY
 enable_language(C) # Needed for LLVM
 find_package(LLVM REQUIRED)
 if((LLVM_VERSION VERSION_LESS 14)
-  OR (LLVM_VERSION VERSION_GREATER_EQUAL 19))
-  message(WARNING "QIR-EE is only tested with LLVM 14-18: found version ${LLVM_VERSION}")
+  OR (LLVM_VERSION VERSION_GREATER_EQUAL 20))
+  message(WARNING "QIR-EE is only tested with LLVM 14-19: found version ${LLVM_VERSION}")
+endif()
+
+if(QIREE_USE_QSIM)
+  # Declare and download qsim: it's header-only and the code is in "lib",
+  # so download it into "external/qsim" directory and include "external"
+  FetchContent_Declare(
+    qsim_content
+    QUIET
+    GIT_REPOSITORY https://github.com/quantumlib/qsim.git
+    GIT_TAG 55b4d0e7ea8f085a1709c2c06ff1e28b3aa93357 # 'main' on 22 Nov 2024
+    SOURCE_SUBDIR "lib" # Don't load top-level cmake file
+    SOURCE_DIR "external/qsim"
+  )
+  FetchContent_MakeAvailable(qsim_content)
+  qiree_add_library(qiree_qsim INTERFACE)
+  add_library(QIREE::qsim ALIAS qiree_qsim)
+  target_include_directories(qiree_qsim SYSTEM INTERFACE
+    "$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/external>"
+    "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/external>"
+  )
 endif()
 
 if(QIREE_USE_XACC)
@@ -185,7 +208,7 @@ add_subdirectory(app)
 #----------------------------------------------------------------------------#
 
 if(QIREE_BUILD_EXAMPLES)
-   add_subdirectory(examples)
+  add_subdirectory(examples)
 endif()
 
 #----------------------------------------------------------------------------#

CMakePresets.json

@@ -1,33 +1,61 @@
 {
-  "version": 3,
-  "cmakeMinimumRequired": {"major": 3, "minor": 21, "patch": 0},
-  "configurePresets": [
-    {
-      "name": "default",
-      "displayName": "Automatic options (debug with tests)",
-      "description": "Dependencies are enabled based on environment probing",
-      "binaryDir": "${sourceDir}/build-${presetName}",
-      "generator": "Ninja",
-      "cacheVariables": {
-        "BUILD_SHARED_LIBS":    {"type": "BOOL",   "value": "ON"},
-        "CMAKE_BUILD_TYPE":     {"type": "STRING", "value": "Debug"},
-        "CMAKE_INSTALL_PREFIX": "${sourceDir}/install-${presetName}"
-      }
-    }
-  ],
-  "buildPresets": [
-    {
-      "name": "default",
-      "jobs": 0,
-      "configurePreset": "default"
-    }
-  ],
-  "testPresets": [
-    {
-      "name": "default",
-      "configurePreset": "default",
-      "output": {"outputOnFailure": true},
-      "execution": {"noTestsAction": "error", "stopOnFailure": false, "jobs": 8}
-    }
-  ]
-}
+"version": 3,
+    "cmakeMinimumRequired": {
+        "major": 3,
+        "minor": 21,
+        "patch": 0
+    },
+    "configurePresets": [
+        {
+            "name": "default",
+            "displayName": "Automatic options (debug with tests)",
+            "description": "Dependencies are enabled based on environment probing",
+            "binaryDir": "${sourceDir}/build-${presetName}",
+            "generator": "Ninja",
+            "cacheVariables": {
+                "BUILD_SHARED_LIBS": {
+                    "type": "BOOL",
+                    "value": "ON"
+                },
+                "CMAKE_BUILD_TYPE": {
+                    "type": "STRING",
+                    "value": "Debug"
+                },
+                "CMAKE_INSTALL_PREFIX": "${sourceDir}/install-${presetName}"
+            }
+        },
+        {
+            "name": "default",
+            "displayName": "Clang 16.0.6 x86_64-pc-linux-gnu",
+            "description": "Using compilers: C = /usr/bin/clang-16, CXX = /usr/bin/clang++-16",
+            "binaryDir": "${sourceDir}/out/build/${presetName}",
+            "cacheVariables": {
+                "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}",
+                "CMAKE_C_COMPILER": "/usr/bin/clang-16",
+                "CMAKE_CXX_COMPILER": "/usr/bin/clang++-16",
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "default",
+            "jobs": 0,
+            "configurePreset": "default"
+        }
+    ],
+    "testPresets": [
+        {
+            "name": "default",
+            "configurePreset": "default",
+            "output": {
+                "outputOnFailure": true
+            },
+            "execution": {
+                "noTestsAction": "error",
+                "stopOnFailure": false,
+                "jobs": 8
+            }
+        }
+    ]
+}

app/CMakeLists.txt

@@ -4,8 +4,8 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #-----------------------------------------------------------------------------#
 
-include(FetchContent)
 FetchContent_Declare(
+  # Command Line Parser for C++ programs
   cli11_proj
   QUIET
   GIT_REPOSITORY https://github.com/CLIUtils/CLI11.git
@@ -14,6 +14,24 @@ FetchContent_Declare(
 
 FetchContent_MakeAvailable(cli11_proj)
 
+#-----------------------------------------------------------------------------#
+# QSIM FRONT END
+#-----------------------------------------------------------------------------#
+
+if(QIREE_USE_QSIM)
+  qiree_add_executable(qir-qsim
+    qir-qsim.cc
+  )
+  target_link_libraries(qir-qsim
+    PUBLIC QIREE::qiree QIREE::qirqsim
+    PRIVATE CLI11::CLI11
+  )
+endif()
+
+#-----------------------------------------------------------------------------#
+# XACC FRONT END
+#-----------------------------------------------------------------------------#
+
 if(QIREE_USE_XACC)
   qiree_add_executable(qir-xacc
     qir-xacc.cc

app/qir-qsim.cc

@@ -0,0 +1,98 @@
+//----------------------------------*-C++-*----------------------------------//
+// Copyright 2024 UT-Battelle, LLC, and other QIR-EE developers.
+// See the top-level COPYRIGHT file for details.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//---------------------------------------------------------------------------//
+//! \file qir-xacc/qir-xacc.cc
+//---------------------------------------------------------------------------//
+#include <cstdlib>
+#include <iostream>
+#include <string>
+#include <string_view>
+#include <CLI/CLI.hpp>
+
+#include "qiree_version.h"
+
+#include "qiree/Executor.hh"
+#include "qiree/Module.hh"
+#include "qiree/QuantumNotImpl.hh"
+#include "qirqsim/QsimDefaultRuntime.hh"
+#include "qirqsim/QsimQuantum.hh"
+
+using namespace std::string_view_literals;
+
+namespace qiree
+{
+namespace app
+{
+void run(std::string const& filename,
+         int num_shots)
+         // bool group_tuples = false)
+{
+    // Load the input
+    Executor execute{Module{filename}};
+
+    // Set up qsim
+    QsimQuantum sim(std::cout, 0);
+
+    // Collect the statistics
+    std::unique_ptr<RuntimeInterface> rt;
+    rt = std::make_unique<QsimDefaultRuntime>(std::cout, sim);
+
+    // Run several time = shots (default 1)
+    for (int i = 0; i < num_shots; i++)
+    {
+        execute(sim, *rt);
+    }
+
+    std::cout << std::endl;
+    std::cout << "Measurement output:" << std::endl;
+    std::cout << "-------------------" << std::endl;
+    std::cout << "Number of shots: " << num_shots << std::endl;
+    std::cout << "Number of qubits: " << sim.num_qubits() << std::endl;
+
+    for(int q_index = 0; q_index < sim.num_qubits(); q_index++){
+        int value_0 = 0;
+        int value_1 = 0;
+        if (auto value = sim.manager.getBufferValue("q"+std::to_string(q_index), "0"); value.has_value()){ value_0 = value.value();}
+        if (auto value = sim.manager.getBufferValue("q"+std::to_string(q_index), "1"); value.has_value()){ value_1 = value.value();}
+        std::cout << "q" << q_index << " {0: " << value_0 << "," << " 1: " << value_1 << "}\n";
+    }
+}
+
+//---------------------------------------------------------------------------//
+}  // namespace app
+}  // namespace qiree
+
+//---------------------------------------------------------------------------//
+/*!
+ * Execute and run.
+ */
+int main(int argc, char* argv[])
+{
+    int num_shots{1};
+    std::string filename;
+    //bool group_tuples{false};
+
+    CLI::App app;
+
+    auto* filename_opt
+        = app.add_option("--input,-i,input", filename, "QIR input file");
+    filename_opt->required();
+
+    auto* nshot_opt
+        = app.add_option("-s,--shots", num_shots, "Number of shots");
+    nshot_opt->capture_default_str();
+
+    //app.add_flag("--group-tuples,!--no-group-tuples",
+    //            group_tuples,
+    //            "Print per-tuple measurement statistics rather than "
+    //            "per-qubit");
+
+    CLI11_PARSE(app, argc, argv);
+
+    //qiree::app::run(filename, num_shots, group_tuples);
+    qiree::app::run(filename, num_shots);
+
+    return EXIT_SUCCESS;
+}

examples/bell_ccx.ll

@@ -0,0 +1,43 @@
+; ModuleID = 'Bell_ccx'
+source_filename = "Bell_ccx"
+
+%Qubit = type opaque
+%Result = type opaque
+
+define void @main() #0 {
+entry:
+  call void @__quantum__qis__h__body(%Qubit* null)
+  call void @__quantum__qis__x__body(%Qubit* inttoptr (i64 1 to %Qubit*))
+  call void @__quantum__qis__ccx__body(%Qubit* null, %Qubit* inttoptr (i64 1 to %Qubit*), %Qubit* inttoptr (i64 2 to %Qubit*))
+  call void @__quantum__qis__mz__body(%Qubit* null, %Result* null)
+  call void @__quantum__qis__mz__body(%Qubit* inttoptr (i64 1 to %Qubit*), %Result* inttoptr (i64 1 to %Result*))
+  call void @__quantum__qis__mz__body(%Qubit* inttoptr (i64 2 to %Qubit*), %Result* inttoptr (i64 2 to %Result*))
+  call void @__quantum__rt__array_record_output(i64 3, i8* null)
+  call void @__quantum__rt__result_record_output(%Result* null, i8* null)
+  call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 1 to %Result*), i8* null)
+  call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 2 to %Result*), i8* null)
+  ret void
+}
+
+declare void @__quantum__qis__h__body(%Qubit*)
+
+declare void @__quantum__qis__x__body(%Qubit*)
+
+declare void @__quantum__qis__ccx__body(%Qubit*, %Qubit*, %Qubit*)
+
+declare void @__quantum__qis__mz__body(%Qubit*, %Result* writeonly) #1
+
+declare void @__quantum__rt__array_record_output(i64, i8*)
+
+declare void @__quantum__rt__result_record_output(%Result*, i8*)
+
+attributes #0 = { "entry_point" "num_required_qubits"="3" "num_required_results"="3" "output_labeling_schema" "qir_profiles"="custom" }
+attributes #1 = { "irreversible" }
+
+!llvm.module.flags = !{!0, !1, !2, !3}
+
+!0 = !{i32 1, !"qir_major_version", i32 1}
+!1 = !{i32 7, !"qir_minor_version", i32 0}
+!2 = !{i32 1, !"dynamic_qubit_management", i1 false}
+!3 = !{i32 1, !"dynamic_result_management", i1 false}
+