fix: configure OpenTrustRegion BLAS fallback (#134)

Co-authored-by: cheolhochoi <cheolhochoi@ultra.tailbd750b.ts.net>

Author: karmachoi

CMakeLists.txt

@@ -165,6 +165,17 @@ if(APPLE)
     set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
 endif()
 
+if(${LINALG_LIB} STREQUAL none)
+    message(FATAL_ERROR "LINALG_LIB=none is not supported because OpenQP builds and links OpenTrustRegion, which requires BLAS/LAPACK. Use LINALG_LIB=auto, a concrete BLAS/LAPACK vendor, or netlib.")
+endif()
+
+# Resolve BLAS/LAPACK before configuring external projects. OpenTrustRegion
+# needs the same BLAS integer-size decision as OpenQP; early resolution also
+# lets a failed system BLAS search fall back to the bundled NetLib target before
+# the external project graph is generated. Linking to oqp happens when
+# findLinearAlgebra() is called again after the oqp target exists.
+findLinearAlgebra()
+
 add_subdirectory(external)
 
 add_definitions(-DOQP)

cmake/oqp_functions.cmake

@@ -106,19 +106,25 @@ macro(findLinearAlgebra)
 
     if(linalg_lib STREQUAL netlib)
       set(_LINALG_LIB_TYPE "NetLib" CACHE INTERNAL "_LIANLG_LIB_TYPE")
-      add_dependencies(oqp LAPACK)
-      target_link_libraries(oqp ${LIBLAPACK} ${LIBBLAS})
+      if(TARGET oqp)
+        add_dependencies(oqp LAPACK)
+        target_link_libraries(oqp ${LIBLAPACK} ${LIBBLAS})
+      endif()
     elseif(linalg_lib STREQUAL Intel10_64_dyn)
       set(_LINALG_LIB_TYPE "MKL_RT" CACHE INTERNAL "_LIANLG_LIB_TYPE")
-      target_link_libraries(oqp ${BLAS_LIBRARIES} ${LAPACK_LIBRARIES})
+      if(TARGET oqp)
+        target_link_libraries(oqp ${BLAS_LIBRARIES} ${LAPACK_LIBRARIES})
+      endif()
       if(LINALG_LIB_INT64)
          set(_MKL_INTERFACE_LAYER "ILP64" CACHE INTERNAL "_MKL_INTERFACE_LAYER")
       else()
          set(_MKL_INTERFACE_LAYER "LP64" CACHE INTERNAL "_MKL_INTERFACE_LAYER")
       endif()
     else()
       set(_LINALG_LIB_TYPE "other" CACHE INTERNAL "_LIANLG_LIB_TYPE")
-      target_link_libraries(oqp ${BLAS_LIBRARIES} ${LAPACK_LIBRARIES})
+      if(TARGET oqp)
+        target_link_libraries(oqp ${BLAS_LIBRARIES} ${LAPACK_LIBRARIES})
+      endif()
     endif()
     unset(linalg_lib)
 endmacro()

external/CMakeLists.txt

@@ -103,23 +103,101 @@ ExternalProject_Add(libecpint
 		   -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
         INSTALL_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> --target install
         )
+if(_LINALG_LIB_TYPE STREQUAL NetLib)
+  if(LINALG_LIB_INT64)
+    set(BLA_LIB_SUFFIX "64")
+  else()
+    set(BLA_LIB_SUFFIX "")
+  endif()
+  if(BUILD_SHARED_LIBS)
+    set(la_fortran_flags "${CMAKE_Fortran_FLAGS} -fpic")
+  else()
+    set(la_fortran_flags ${CMAKE_Fortran_FLAGS})
+  endif()
+  set(LAPACK_PREFIX ${CMAKE_BINARY_DIR}/external/lapack CACHE INTERNAL "LAPACK_PREFIX")
+  set(LIBLAPACK ${LAPACK_PREFIX}/src/lapack-build/lib/liblapack${BLA_LIB_SUFFIX}.a CACHE INTERNAL "LIBLAPACK")
+
+  set(LIBBLAS   ${LAPACK_PREFIX}/src/lapack-build/lib/libblas${BLA_LIB_SUFFIX}.a CACHE INTERNAL "LIBBLAS")
+  message(STATUS "BLAS_SUFFIX = ${BLA_LIB_SUFFIX}")
+
+
+  ExternalProject_Add(LAPACK
+        PREFIX ${CMAKE_SOURCE_DIR}/external/lapack
+        URL https://github.com/Reference-LAPACK/lapack/archive/refs/tags/v3.10.0.tar.gz
+        URL_HASH SHA256=328c1bea493a32cac5257d84157dc686cc3ab0b004e2bea22044e0a59f6f8a19
+        BINARY_DIR ${CMAKE_BINARY_DIR}/external/lapack/src/lapack-build
+        STAMP_DIR  ${CMAKE_BINARY_DIR}/external/lapack/src/lapack-stamp
+        BUILD_BYPRODUCTS ${LAPACK_PREFIX}/src/lapack-build/lib/liblapack${BLA_LIB_SUFFIX}.a
+                         ${LAPACK_PREFIX}/src/lapack-build/lib/libblas${BLA_LIB_SUFFIX}.a
+        UPDATE_COMMAND ""
+        PATCH_COMMAND /usr/bin/perl -0pi -e "s/cmake_minimum_required\\(VERSION 3\\.2\\)/cmake_minimum_required(VERSION 3.5)/g" <SOURCE_DIR>/CMakeLists.txt <SOURCE_DIR>/INSTALL/CMakeLists.txt
+        INSTALL_COMMAND ""
+        CMAKE_ARGS -DBUILD_INDEX64=${LINALG_LIB_INT64}
+                   -DBUILD_SINGLE=OFF
+                   -DBUILD_DOUBLE=ON
+                   -DBUILD_COMPLEX=OFF
+                   -DBUILD_COMPLEX16=OFF
+                   -DUSE_OPTIMIZED_BLAS=OFF
+                   -DUSE_OPTIMIZED_LAPACK=OFF
+                   -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+                   -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+                   -DCMAKE_Fortran_COMPILER=${CMAKE_Fortran_COMPILER}
+                   -DCMAKE_Fortran_FLAGS=${la_fortran_flags}
+                   -DCMAKE_POLICY_VERSION_MINIMUM=3.5
+                   -DCMAKE_TRY_COMPILE_PLATFORM_VARIABLES=CMAKE_POLICY_VERSION_MINIMUM
+                   -DCMAKE_GENERATOR:INTERNAL=${CMAKE_GENERATOR}
+        )
+endif()
+set(otr_integer_flags "")
+if(LINALG_LIB_INT64)
+    if("${CMAKE_Fortran_COMPILER_ID}" STREQUAL "GNU")
+        set(otr_integer_flags "-fdefault-integer-8")
+    elseif("${CMAKE_Fortran_COMPILER_ID}" STREQUAL "Flang")
+        set(otr_integer_flags "-fdefault-integer-8")
+    elseif("${CMAKE_Fortran_COMPILER_ID}" STREQUAL "Intel" OR "${CMAKE_Fortran_COMPILER_ID}" STREQUAL "IntelLLVM")
+        set(otr_integer_flags "-i8")
+    endif()
+endif()
+set(otr_fortran_flags "${CMAKE_Fortran_FLAGS} ${OTR_DEFS} ${otr_integer_flags}")
+if("${CMAKE_Fortran_COMPILER_ID}" STREQUAL "GNU" AND CMAKE_Fortran_COMPILER_VERSION VERSION_GREATER 10.0)
+    set(otr_fortran_flags "${otr_fortran_flags} -fallow-argument-mismatch")
+endif()
+set(OTR_CMAKE_ARGS
+        -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/external/install/opentrustregion
+        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+        -DBLA_SIZEOF_INTEGER=${BLA_SIZEOF_INTEGER}
+        -DINTEGER_SIZE=${BLA_SIZEOF_INTEGER}
+        -DBUILD_SHARED_LIBS=OFF
+        -DBUILD_TESTS=OFF
+        -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+        -DCMAKE_Fortran_COMPILER=${CMAKE_Fortran_COMPILER}
+        -DCMAKE_Fortran_FLAGS=${otr_fortran_flags}
+        -DCMAKE_GENERATOR:INTERNAL=${CMAKE_GENERATOR}
+)
+if(_LINALG_LIB_TYPE STREQUAL NetLib)
+    list(APPEND OTR_CMAKE_ARGS
+        -DBLAS_LIBRARIES=${LIBBLAS}
+        -DLAPACK_LIBRARIES=${LIBLAPACK}
+    )
+elseif(DEFINED BLA_VENDOR)
+    list(APPEND OTR_CMAKE_ARGS -DBLA_VENDOR=${BLA_VENDOR})
+endif()
+
 ExternalProject_Add(libopentrustregion
     PREFIX ${CMAKE_SOURCE_DIR}/external/opentrustregion
     URL https://github.com/eriksen-lab/opentrustregion/archive/refs/tags/v2.0.0.tar.gz
     URL_HASH SHA256=682201cc9cc850a892d132e5e5fc11f6d87f8cd843fdbad88dafbf7277407f1c 
     UPDATE_COMMAND ""
     PATCH_COMMAND
     UPDATE_COMMAND ""
-    CMAKE_ARGS
-        -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/external/install/opentrustregion
-        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-        -DBLA_SIZEOF_INTEGER=${BLA_SIZEOF_INTEGER}
-        -DBUILD_SHARED_LIBS=OFF
-        -DBUILD_TESTS=OFF
+    CMAKE_ARGS ${OTR_CMAKE_ARGS}
     BINARY_DIR ${CMAKE_BINARY_DIR}/external/opentrustregion/src/libopentrustregion-build-${CMAKE_Fortran_COMPILER_ID}
     #    INSTALL_DIR ${CMAKE_BINARY_DIR}/external/install/opentrustregion
     #    STEP_TARGETS build install
 )
+if(_LINALG_LIB_TYPE STREQUAL NetLib)
+  add_dependencies(libopentrustregion LAPACK)
+endif()
 
 set(OTR_LIB_NAME "${CMAKE_STATIC_LIBRARY_PREFIX}opentrustregion${OTR_SUFFIX}${CMAKE_STATIC_LIBRARY_SUFFIX}")
 if(ENABLE_Formatter)
@@ -161,47 +239,6 @@ if(ENABLE_Formatter)
                    )
 endif()
 
-if(_LINALG_LIB_TYPE STREQUAL NetLib)
-  if(LINALG_LIB_INT64)
-    set(BLA_LIB_SUFFIX "64")
-  else()
-    set(BLA_LIB_SUFFIX "")
-  endif()
-  if(BUILD_SHARED_LIBS)
-    set(la_fortran_flags "${CMAKE_Fortran_FLAGS} -fpic")
-  else()
-    set(la_fortran_flags ${CMAKE_Fortran_FLAGS})
-  endif()
-  set(LAPACK_PREFIX ${CMAKE_BINARY_DIR}/external/lapack CACHE INTERNAL "LAPACK_PREFIX")
-  set(LIBLAPACK ${LAPACK_PREFIX}/src/lapack-build/lib/liblapack${BLA_LIB_SUFFIX}.a CACHE INTERNAL "LIBLAPACK")
-
-  set(LIBBLAS   ${LAPACK_PREFIX}/src/lapack-build/lib/libblas${BLA_LIB_SUFFIX}.a CACHE INTERNAL "LIBBLAS")
-  message(STATUS "BLAS_SUFFIX = ${BLA_LIB_SUFFIX}")
-
 
-  ExternalProject_Add(LAPACK
-        PREFIX ${CMAKE_SOURCE_DIR}/external/lapack
-        URL https://github.com/Reference-LAPACK/lapack/archive/refs/tags/v3.10.0.tar.gz
-        URL_HASH SHA256=328c1bea493a32cac5257d84157dc686cc3ab0b004e2bea22044e0a59f6f8a19
-        BINARY_DIR ${CMAKE_BINARY_DIR}/external/lapack/src/lapack-build
-        STAMP_DIR  ${CMAKE_BINARY_DIR}/external/lapack/src/lapack-stamp
-        BUILD_BYPRODUCTS ${LAPACK_PREFIX}/src/lapack-build/lib/liblapack${BLA_LIB_SUFFIX}.a
-                         ${LAPACK_PREFIX}/src/lapack-build/lib/libblas${BLA_LIB_SUFFIX}.a
-        UPDATE_COMMAND ""
-        INSTALL_COMMAND ""
-        CMAKE_ARGS -DBUILD_INDEX64=${LINALG_LIB_INT64}
-                   -DBUILD_SINGLE=OFF
-                   -DBUILD_DOUBLE=ON
-                   -DBUILD_COMPLEX=OFF
-                   -DBUILD_COMPLEX16=OFF
-                   -DUSE_OPTIMIZED_BLAS=OFF
-                   -DUSE_OPTIMIZED_LAPACK=OFF
-                   -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-                   -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-                   -DCMAKE_Fortran_COMPILER=${CMAKE_Fortran_COMPILER}
-                   -DCMAKE_Fortran_FLAGS=${la_fortran_flags}
-                   -DCMAKE_GENERATOR:INTERNAL=${CMAKE_GENERATOR}
-        )
-endif()
 
 set_directory_properties(PROPERTIES CLEAN_NO_CUSTOM 1)

tests/test_opentrustregion_linalg_config.py

@@ -0,0 +1,50 @@
+import unittest
+from pathlib import Path
+
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+class OpenTrustRegionLinalgConfigTests(unittest.TestCase):
+    def test_linalg_none_is_rejected_before_external_build(self):
+        top_cmake = (ROOT / "CMakeLists.txt").read_text()
+
+        self.assertIn("LINALG_LIB=none is not supported", top_cmake)
+        self.assertIn("OpenTrustRegion", top_cmake)
+        self.assertIn("findLinearAlgebra()", top_cmake)
+        self.assertLess(
+            top_cmake.index("findLinearAlgebra()"),
+            top_cmake.index("add_subdirectory(external)"),
+        )
+
+    def test_opentrustregion_receives_resolved_linalg_configuration(self):
+        external_cmake = (ROOT / "external" / "CMakeLists.txt").read_text()
+
+        self.assertIn("OTR_CMAKE_ARGS", external_cmake)
+        self.assertIn("INTEGER_SIZE=${BLA_SIZEOF_INTEGER}", external_cmake)
+        self.assertIn("OTR_DEFS", external_cmake)
+        self.assertIn("otr_integer_flags", external_cmake)
+        self.assertIn("fdefault-integer-8", external_cmake)
+        self.assertIn("fallow-argument-mismatch", external_cmake)
+        self.assertIn("CMAKE_Fortran_FLAGS=${otr_fortran_flags}", external_cmake)
+        self.assertIn("BLAS_LIBRARIES=${LIBBLAS}", external_cmake)
+        self.assertIn("LAPACK_LIBRARIES=${LIBLAPACK}", external_cmake)
+        self.assertIn("add_dependencies(libopentrustregion LAPACK)", external_cmake)
+        self.assertIn("CMAKE_POLICY_VERSION_MINIMUM=3.5", external_cmake)
+        self.assertIn("PATCH_COMMAND /usr/bin/perl", external_cmake)
+        self.assertIn("cmake_minimum_required(VERSION 3.5)", external_cmake)
+        self.assertLess(
+            external_cmake.index("ExternalProject_Add(LAPACK"),
+            external_cmake.index("ExternalProject_Add(libopentrustregion"),
+        )
+
+    def test_find_linalg_can_run_before_oqp_target_exists(self):
+        functions_cmake = (ROOT / "cmake" / "oqp_functions.cmake").read_text()
+
+        self.assertIn("if(TARGET oqp)", functions_cmake)
+        self.assertIn("add_dependencies(oqp LAPACK)", functions_cmake)
+        self.assertIn("target_link_libraries(oqp ${BLAS_LIBRARIES} ${LAPACK_LIBRARIES})", functions_cmake)
+
+
+if __name__ == "__main__":
+    unittest.main()