[WIP] Move OpenQL to modern CMake practices

.gitignore

@@ -37,4 +37,5 @@ docs/_templates
 docs/_templates
 
 /.idea
+.vscode
 /cmake-build-*

.gitmodules

@@ -14,3 +14,6 @@
 	path = deps/json
 	url = https://github.com/nlohmann/json.git
 	shallow = true
+[submodule "deps/googletest"]
+	path = deps/googletest
+	url = https://github.com/google/googletest.git

RELEASE.md

@@ -10,7 +10,7 @@ secrets are configured correctly.
    is to be released. For example, `release-0.0.1`, but the suffix doesn't
    matter.
 
- - Change the version in `include/ql/version.h` (this is the only functional
+ - Change the version in `src/ql/include/ql/version.h` (this is the only functional
    place where the version is hardcoded) and change any other files where
    applicable (changelog, etc) and update `CHANGELOG.md` accordingly, then
    commit and make a PR for it.
@@ -35,7 +35,7 @@ secrets are configured correctly.
  - If needed, also merge to `master`.
 
  - Draft a new release through the GitHub interface. Set the "tag version"
-   to the same version you put in `include/ql/version.h`, the title to
+   to the same version you put in `src/ql/include/ql/version.h`, the title to
    "Release `version`: `name`", and write release notes in the body. The
    release notes should include at least:
 

docs/conf.py

@@ -129,14 +129,14 @@ def get_version(verbose=0):
     """ Extract version information from source code """
 
     matcher = re.compile('[\t ]*#define[\t ]+OPENQL_VERSION_STRING[\t ]+"(.*)"')
-    with open(os.path.join('..', 'include', 'ql', 'version.h'), 'r') as f:
+    with open(os.path.join('..', 'src', 'ql', 'include', 'ql', 'version.h'), 'r') as f:
         for ln in f:
             m = matcher.match(ln)
             if m:
                 version = m.group(1)
                 break
         else:
-            raise Exception('failed to parse version string from include/ql/version.h')
+            raise Exception('failed to parse version string from src/ql/include/ql/version.h')
 
     return version
 

examples/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.1 FATAL_ERROR)
 
-add_openql_test(multi_qubits_randomized_benchmarking multi_qubits_randomized_benchmarking.cc ../tests)
-add_openql_test(randomized_benchmarking randomized_benchmarking.cc ../tests)
-add_openql_test(rb_single rb_single.cc ../tests)
-add_openql_test(simple simple.cc ../tests)
+add_openql_test(multi_qubits_randomized_benchmarking multi_qubits_randomized_benchmarking.cc)
+add_openql_test(randomized_benchmarking randomized_benchmarking.cc)
+add_openql_test(rb_single rb_single.cc)
+add_openql_test(simple simple.cc)

examples/multi_qubits_randomized_benchmarking.cc

@@ -8,7 +8,7 @@
 
 #include <time.h>
 
-#include <openql>
+#include "openql.h"
 
 // clifford inverse lookup table for grounded state
 const size_t inv_clifford_lut_gs[] = {0, 2, 1, 3, 8, 10, 6, 11, 4, 9, 5, 7, 12, 16, 23, 21, 13, 17, 18, 19, 20, 15, 22, 14};

examples/simple.cc

@@ -1,5 +1,5 @@
 #include <iostream>
-#include <openql>
+#include "openql.h"
 
 int main(int argc, char **argv) {
     // create platform

setup.py

@@ -16,7 +16,7 @@
 
 root_dir   = os.getcwd()                        # root of the repository
 src_dir    = root_dir   + os.sep + 'src'        # C++ source directory
-inc_dir    = root_dir   + os.sep + 'include'    # C++ include directory
+inc_dir = root_dir + os.sep + 'src' + os.sep + 'ql' + os.sep + 'include'    # C++ include directory
 pysrc_dir  = root_dir   + os.sep + 'python'     # Python source files
 target_dir = root_dir   + os.sep + 'pybuild'    # python-specific build directory
 build_dir  = target_dir + os.sep + 'build'      # directory for setuptools to dump various files into

src/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(ql)

src/openql.cc

@@ -0,0 +1 @@
+#include "openql.h"

src/ql/CMakeLists.txt

@@ -0,0 +1,24 @@
+# Generate a header file with configuration options that cannot be compiled
+# (entirely) into the shared/static library due to use of templates.
+set(QL_CHECKED_VEC ${OPENQL_CHECKED_VEC})
+set(QL_CHECKED_LIST ${OPENQL_CHECKED_LIST})
+set(QL_CHECKED_MAP ${OPENQL_CHECKED_MAP})
+set(QL_SHARED_LIB ${BUILD_SHARED_LIBS})
+configure_file(
+    "include/ql/config.h.template"
+    "${CMAKE_CURRENT_BINARY_DIR}/include/ql/config.h"
+)
+
+add_library(config INTERFACE)
+target_include_directories(config INTERFACE "include")
+target_include_directories(config INTERFACE "${CMAKE_CURRENT_BINARY_DIR}/include/")
+
+add_subdirectory(api)
+add_subdirectory(arch)
+add_subdirectory(com)
+add_subdirectory(ir)
+add_subdirectory(pass)
+add_subdirectory(pmgr)
+add_subdirectory(resource)
+add_subdirectory(rmgr)
+add_subdirectory(utils)

src/ql/api/CMakeLists.txt

@@ -0,0 +1,20 @@
+add_library(api
+    "misc.cc"
+    "pass.cc"
+    "compiler.cc"
+    "platform.cc"
+    "creg.cc"
+    "operation.cc"
+    "unitary.cc"
+    "kernel.cc"
+    "program.cc"
+    "cqasm_reader.cc"
+)
+
+target_include_directories(api PUBLIC include)
+
+target_link_libraries(api PRIVATE config)
+target_link_libraries(api PUBLIC ir_compat)
+target_link_libraries(api PUBLIC pmgr)
+target_link_libraries(api PUBLIC com_dec)
+target_link_libraries(api PUBLIC arch_diamond_annotations)

src/ql/arch/CMakeLists.txt

@@ -0,0 +1,23 @@
+add_library(all_architectures OBJECT)
+
+macro(add_arch_library name)
+    add_library("${name}" OBJECT "${ARGN}")
+    target_sources(all_architectures PUBLIC $<TARGET_OBJECTS:${name}>)
+endmacro()
+
+add_subdirectory(cc)
+add_subdirectory(cc_light)
+add_subdirectory(diamond)
+add_subdirectory(none)
+
+add_library(arch
+    "info_base.cc"
+    "architecture.cc"
+    "factory.cc"
+)
+
+target_include_directories(arch PUBLIC include)
+
+target_link_libraries(arch PUBLIC utils)
+target_link_libraries(arch PRIVATE ir_compat)
+target_link_libraries(arch PRIVATE pmgr)

src/ql/arch/architecture.cc

@@ -4,6 +4,8 @@
  */
 
 #include "ql/arch/architecture.h"
+#include "ql/pmgr/declarations.h"
+#include "ql/ir/compat/platform.h"
 
 namespace ql {
 namespace arch {

src/ql/arch/cc/CMakeLists.txt

@@ -0,0 +1,23 @@
+add_arch_library(arch_cc
+    "info.cc"
+    "pass/gen/vq1asm/detail/backend.cc"
+    "pass/gen/vq1asm/detail/codegen.cc"
+    "pass/gen/vq1asm/detail/codesection.cc"
+    "pass/gen/vq1asm/detail/datapath.cc"
+    "pass/gen/vq1asm/detail/functions.cc"
+    "pass/gen/vq1asm/detail/operands.cc"
+    "pass/gen/vq1asm/detail/settings.cc"
+    "pass/gen/vq1asm/detail/vcd.cc"
+    "pass/gen/vq1asm/vq1asm.cc"
+)
+
+create_resource(cc_hwconf_default "resources/hwconf_default.json" "${CMAKE_CURRENT_BINARY_DIR}/include/ql/arch/cc/resources/hwconf_default.inc")
+add_dependencies(arch_cc cc_hwconf_default)
+
+target_include_directories(arch_cc PUBLIC include)
+target_include_directories(arch_cc PUBLIC "${CMAKE_CURRENT_BINARY_DIR}/include")
+
+target_link_libraries(arch_cc PUBLIC utils)
+target_link_libraries(arch_cc PUBLIC pmgr)
+target_link_libraries(arch_cc PRIVATE ir)
+target_link_libraries(arch_cc PUBLIC config)

include/ql/arch/cc/info.h → src/ql/arch/cc/include/ql/arch/cc/info.h

@@ -12,6 +12,7 @@
 #include "ql/utils/json.h"
 #include "ql/pmgr/manager.h"
 #include "ql/arch/info_base.h"
+#include "ql/arch/factory.h"
 
 namespace ql {
 namespace arch {
@@ -22,7 +23,8 @@ namespace cc {
  */
 class Info : public InfoBase {
 public:
-
+    static bool is_architecture_registered;
+
     /**
      * Writes the documentation for this architecture to the given output
      * stream.
@@ -77,7 +79,6 @@ class Info : public InfoBase {
      * is considered a backend pass.
      */
     void populate_backend_passes(pmgr::Manager &manager, const utils::Str &variant) const override;
-
 };
 
 } // namespace cc

src/ql/arch/cc/pass/gen/vq1asm/detail/backend.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/backend.h

@@ -8,9 +8,9 @@
 
 #pragma once
 
-#include "types.h"
-#include "options.h"
-#include "codegen.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/options.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/codegen.h"
 
 #include "ql/ir/ir.h"
 

src/ql/arch/cc/pass/gen/vq1asm/detail/bundle_info.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/bundle_info.h

@@ -4,9 +4,9 @@
 
 #pragma once
 
-#include "types.h"
-#include "options.h"
-#include "settings.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/options.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/settings.h"
 
 namespace ql {
 namespace arch {

src/ql/arch/cc/pass/gen/vq1asm/detail/codegen.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/codegen.h

@@ -11,15 +11,15 @@
 
 #include "ql/ir/ir.h"
 
-#include "operands.h"
-#include "types.h"
-#include "options.h"
-#include "bundle_info.h"
-#include "codesection.h"
-#include "functions.h"
-#include "datapath.h"
-#include "settings.h"
-#include "vcd.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/operands.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/options.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/bundle_info.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/codesection.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/functions.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/datapath.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/settings.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/vcd.h"
 
 namespace ql {
 namespace arch {

src/ql/arch/cc/pass/gen/vq1asm/detail/codesection.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/codesection.h

@@ -2,8 +2,8 @@
 
 #include "ql/ir/ir.h"
 
-#include "types.h"
-#include "operands.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/operands.h"
 
 // Constants
 // FIXME: move out of .h

src/ql/arch/cc/pass/gen/vq1asm/detail/datapath.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/datapath.h

@@ -10,8 +10,8 @@
 
 #include <iomanip>
 
-#include "types.h"
-#include "bundle_info.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/bundle_info.h"
 
 #include "ql/utils/logger.h"
 #include "ql/ir/compat/compat.h"

src/ql/arch/cc/pass/gen/vq1asm/detail/functions.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/functions.h

@@ -2,10 +2,10 @@
 
 #include "ql/ir/ir.h"
 
-#include "types.h"
-#include "operands.h"
-#include "datapath.h"
-#include "codesection.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/operands.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/datapath.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/codesection.h"
 
 namespace ql {
 namespace arch {

src/ql/arch/cc/pass/gen/vq1asm/detail/operands.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/operands.h

@@ -7,7 +7,7 @@
 
 #include "ql/ir/ir.h"
 
-#include "types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
 
 /**
  * Helper macro for QL_ICE() that throws when the given condition is not

src/ql/arch/cc/pass/gen/vq1asm/detail/options.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/options.h

@@ -8,7 +8,8 @@
 
 #pragma once
 
-#include "types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/config.h"
 
 // constants
 #define CC_BACKEND_VERSION_STRING       "0.4.0"
@@ -18,7 +19,7 @@
 #define OPT_SUPPORT_STATIC_CODEWORDS    1   // support (currently: require) static codewords, instead of allocating them on demand
 #define OPT_STATIC_CODEWORDS_ARRAYS     1   // JSON field static_codeword_override is an array with one element per qubit parameter
 #define OPT_VECTOR_MODE                 0   // 1=generate single code word for all output groups together (requires codewords allocated by backend)
-#define OPT_CC_USER_FUNCTIONS           1   // 1=add support for some user functions (experimental)
+
 
 // NOTE JvS: I added these to the documentation string for the backend pass, so
 //  you can see these values at runtime.

src/ql/arch/cc/pass/gen/vq1asm/detail/settings.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/settings.h

@@ -8,8 +8,8 @@
 
 #pragma once
 
-#include "types.h"
-#include "options.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/options.h"
 
 #include "ql/ir/compat/platform.h"  // FIXME
 #include "ql/ir/ir.h"

src/ql/arch/cc/pass/gen/vq1asm/detail/vcd.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/detail/vcd.h

@@ -10,8 +10,8 @@
 
 #include "ql/utils/vcd.h"
 
-#include "types.h"
-#include "settings.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/types.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/settings.h"
 
 namespace ql {
 namespace arch {

include/ql/arch/cc/pass/gen/vq1asm/vq1asm.h → src/ql/arch/cc/include/ql/arch/cc/pass/gen/vq1asm/vq1asm.h

@@ -18,6 +18,8 @@ namespace vq1asm {
  * QuTech Central Controller Q1 processor assembly generator pass.
  */
 class GenerateVQ1AsmPass : public pmgr::pass_types::Transformation {
+    static bool is_pass_registered;
+
 protected:
 
     /**

src/ql/arch/cc/info.cc

@@ -14,6 +14,8 @@ namespace ql {
 namespace arch {
 namespace cc {
 
+bool Info::is_architecture_registered = Factory::register_architecture<Info>();
+
 // local constants
 const utils::Str predicateKeyInstructionType = "cc-desugar-instruction-type";
 const utils::Str predicateValueMeas = "cc-desugar-meas";
@@ -655,7 +657,6 @@ void Info::post_process_platform(
  * is considered a backend pass.
  */
 void Info::populate_backend_passes(pmgr::Manager &manager, const utils::Str &variant) const {
-
     // Remove prescheduler if enabled implicitly (pointless since we add our own scheduling).
     // FIXME: bit of a hack, and invalidates https://openql.readthedocs.io/en/latest/gen/reference_architectures.html#default-pass-list
     utils::Str ps_name = "prescheduler";

src/ql/arch/cc/pass/gen/vq1asm/detail/backend.cc

@@ -5,8 +5,8 @@
  * @brief  backend for the Central Controller
  */
 
-#include "backend.h"
-#include "operands.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/backend.h"
+#include "ql/arch/cc/pass/gen/vq1asm/detail/operands.h"
 
 #include "ql/utils/str.h"
 #include "ql/utils/filesystem.h"