Allow building static CQiree

.clang-format

@@ -135,5 +135,8 @@ StatementMacros:
   - QT_REQUIRE_VERSION
 TabWidth:        8
 UseTab:          Never
+---
+Language: Json
+DisableFormat: true
 ...
 # vim: set ft=yaml ts=2 sw=2 :

.github/workflows/build-fast.yml

@@ -10,18 +10,30 @@ concurrency:
 
 jobs:
   linux:
-    name: ${{matrix.runner}}-${{matrix.compiler}}-${{matrix.version}}-llvm${{matrix.llvm}}
+    name: ${{matrix.runner}}-${{matrix.compiler}}-${{matrix.version}}-${{ matrix.shared == 'ON' && 'shared' || 'static' }}-llvm${{matrix.llvm}}
     strategy:
       matrix:
         include:
           - runner: jammy
             compiler: gcc
             version: 12
             llvm: 14
+            shared: ON
+          - runner: jammy
+            compiler: gcc
+            version: 12
+            llvm: 14
+            shared: OFF
+          - runner: jammy
+            compiler: clang
+            version: 15
+            llvm: 15
+            shared: ON
           - runner: jammy
             compiler: clang
             version: 15
             llvm: 15
+            shared: OFF
     runs-on: >-
       ${{  matrix.runner == 'focal' && 'ubuntu-20.04'
         || matrix.runner == 'jammy' && 'ubuntu-22.04'
@@ -67,6 +79,7 @@ jobs:
             -DQIREE_BUILD_TESTS:BOOL=ON \
             -DQIREE_DEBUG:BOOL=ON \
             -DQIREE_USE_XACC:BOOL=OFF \
+            -DQIREE_SHARED_LIBS:BOOL=${{ matrix.shared }} \
             -DCMAKE_BUILD_TYPE="Release" \
             -DCMAKE_INSTALL_PREFIX="${{github.workspace}}/install" \
             -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \

.pre-commit-config.yaml

@@ -9,6 +9,8 @@ repos:
     - id: check-shebang-scripts-are-executable
     - id: check-json
     - id: check-yaml
+      # .clang-format contains multiple documents for different languages
+      args: ['--allow-multiple-documents']
     - id: end-of-file-fixer
       exclude: '\.(diff|patch)$'
     - id: trailing-whitespace

CMakeLists.txt

@@ -38,6 +38,7 @@ 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)
+option(QIREE_SHARED_LIBS "Build shared libraries, not static libraries" ON)
 
 qiree_set_default(BUILD_TESTING ${QIREE_BUILD_TESTS})
 
@@ -77,10 +78,10 @@ qiree_set_default(CMAKE_CXX_EXTENSIONS OFF)
 
 ### Linking flags ###
 # Default to building shared libraries (*not* a cache variable)
-qiree_set_default(BUILD_SHARED_LIBS ON)
+qiree_set_default(BUILD_SHARED_LIBS ${QIREE_SHARED_LIBS})
 # Inform installed binaries of external library rpaths
 qiree_set_default(CMAKE_INSTALL_RPATH_USE_LINK_PATH ON)
-if(BUILD_SHARED_LIBS)
+if(QIREE_SHARED_LIBS)
   # Inform installed binaries of internal library rpaths
   qiree_set_default(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_FULL_LIBDIR}")
   # Do not relink libs/binaries when dependent shared libs change
@@ -113,8 +114,8 @@ 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 21))
-  message(WARNING "QIR-EE is only tested with LLVM 14-20: found version ${LLVM_VERSION}")
+  OR (LLVM_VERSION VERSION_GREATER_EQUAL 22))
+  message(WARNING "QIR-EE is only tested with LLVM 14-21: found version ${LLVM_VERSION}")
 endif()
 
 if(QIREE_USE_QSIM)

CMakePresets.json

@@ -13,10 +13,6 @@
             "binaryDir": "${sourceDir}/build-${presetName}",
             "generator": "Ninja",
             "cacheVariables": {
-                "BUILD_SHARED_LIBS": {
-                    "type": "BOOL",
-                    "value": "ON"
-                },
                 "CMAKE_BUILD_TYPE": {
                     "type": "STRING",
                     "value": "Debug"

README.md

@@ -40,7 +40,7 @@ doc` (user) or `make doxygen` (developer).
 
 There are two dependencies for QIR-EE to work properly. Please make sure to
 download and install the most current versions of:
-1. [LLVM](https://releases.llvm.org/) (we have tested versions 14 through 18)
+1. [LLVM](https://releases.llvm.org/) (we have tested versions 14 through 21)
 2. [XACC](https://github.com/ORNL-QCI/xacc) (repo that is actively
    maintained -- not the eclipse one; currently required for execution in
    this version of qir-ee; we recommend setting option `-DQIREE_MINIMAL_BUILD=ON`

src/cqiree/CMakeLists.txt

@@ -12,7 +12,15 @@ if(QIREE_USE_QSIM)
   list(APPEND _CQIREE_LIBS QIREE::qirqsim)
 endif()
 
-qiree_add_library(cqiree MODULE
+if(QIREE_SHARED_LIBS)
+    # When building with shared libs, this should be a shared library that can
+    # be dlopen()'d.
+    set(_LIB_TYPE MODULE)
+else()
+    set(_LIB_TYPE)
+endif()
+
+qiree_add_library(cqiree ${_LIB_TYPE}
   CQiree.cc
   QireeManager.cc
 )
@@ -28,10 +36,10 @@ target_link_libraries(cqiree
 #----------------------------------------------------------------------------#
 
 # C/C++ source headers
-install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/cqiree"
-  DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
+install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/"
+  DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/cqiree"
   COMPONENT development
-  FILES_MATCHING REGEX ".*\\.hh$"
+  FILES_MATCHING REGEX ".*\\.hh?$"
 )
 
 #-----------------------------------------------------------------------------#

src/cqiree/CQiree.h

@@ -7,14 +7,13 @@
 //---------------------------------------------------------------------------//
 #pragma once
 
-#include <cstdint>
+#include <stddef.h>
+#include <stdint.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#include <stddef.h>
-#include <stdint.h>
-
 /* Opaque pointer to QireeManager */
 typedef struct CQiree_s CQiree;
 

src/qiree_config.h.in

@@ -12,5 +12,6 @@
 #cmakedefine01 QIREE_DEBUG
 #cmakedefine01 QIREE_USE_QSIM
 #cmakedefine01 QIREE_USE_XACC
+#cmakedefine01 QIREE_SHARED_LIBS
 
 #endif /* qiree_config_h */

test/CMakeLists.txt

@@ -69,7 +69,13 @@ qiree_add_test(qiree ResultDistribution)
 #---------------------------------------------------------------------------##
 
 qiree_add_test(cqiree CQiree)
-add_dependencies(cqiree_CQireeTest cqiree)
+if(QIREE_SHARED_LIBS)
+    # Tester uses dlopen()
+    add_dependencies(cqiree_CQireeTest cqiree)
+else()
+    # Statically link tester with cqiree
+    target_link_libraries(cqiree_CQireeTest cqiree)
+endif()
 
 #---------------------------------------------------------------------------##
 # QIRXACC TESTS

test/cqiree/CQiree.test.cc

@@ -7,13 +7,15 @@
 //---------------------------------------------------------------------------//
 #include "cqiree/CQiree.h"
 
+#include <algorithm>
 #include <array>
 #include <cstdint>
 #include <fstream>
 #include <string>
 #include <vector>
 #include <dlfcn.h>
 
+#include "qiree_config.h"
 #include "qiree_targets.h"
 
 #include "qiree/Assert.hh"
@@ -43,15 +45,21 @@ class CQireeTest : public ::qiree::test::Test
   protected:
     void SetUp() override
     {
+#if QIREE_SHARED_LIBS
         lib_handle_ = dlopen(cqiree_library_path, RTLD_LAZY);
         ASSERT_NE(lib_handle_, nullptr)
             << "Failed to load libcqiree: " << dlerror();
-
-#define LOAD_FUNCPTR(FUNC)                           \
-    FUNC##_fn_ = reinterpret_cast<qiree_##FUNC##_t>( \
-        dlsym(lib_handle_, "qiree_" #FUNC));         \
-    ASSERT_NE(FUNC##_fn_, nullptr)                   \
-        << "Failed to load " << #FUNC << ": " << dlerror();
+#endif
+
+#if QIREE_SHARED_LIBS
+#    define LOAD_FUNCPTR(FUNC)                           \
+        FUNC##_fn_ = reinterpret_cast<qiree_##FUNC##_t>( \
+            dlsym(lib_handle_, "qiree_" #FUNC));         \
+        ASSERT_NE(FUNC##_fn_, nullptr)                   \
+            << "Failed to load " << #FUNC << ": " << dlerror();
+#else
+#    define LOAD_FUNCPTR(FUNC) FUNC##_fn_ = qiree_##FUNC;
+#endif
         LOAD_FUNCPTR(create);
         LOAD_FUNCPTR(load_module_from_memory);
         LOAD_FUNCPTR(load_module_from_file);