try harder when forwarding compiler env vars

Author: kevinushey

R/utils.R

@@ -2,23 +2,23 @@
 # generate paths consumable by the compilers and linkers
 # in particular, on Windows and Solaris, this means the path _cannot_ be quoted !!
 asBuildPath <- function(path) {
-   
+
    # normalize paths using forward slashes
    path <- normalizePath(path, winslash = "/", mustWork = FALSE)
-   
+
    # prefer short path names if the path has spaces
    if (is_windows() && grepl(" ", path, fixed = TRUE))
       path <- utils::shortPathName(path)
-   
+
    # if we still have spaces, and we're not Windows or Solaris, try quoting
    if (grepl(" ", path, fixed = TRUE) && !is_solaris())
       path <- shQuote(path)
-   
+
    # ensure we use forward slashes, even on Windows
    path <- chartr("\\", "/", path)
 
    # return path
    path
-   
+
 }
 

src/install.libs.R

@@ -1,27 +1,27 @@
 
 # !diagnostics suppress=R_PACKAGE_DIR,SHLIB_EXT,R_ARCH
 .install.libs <- function(tbbLib) {
-   
+
    # copy default library
    files <- Sys.glob(paste0("*", SHLIB_EXT))
    dest <- file.path(R_PACKAGE_DIR, paste0("libs", R_ARCH))
    dir.create(dest, recursive = TRUE, showWarnings = FALSE)
    file.copy(files, dest, overwrite = TRUE)
-   
+
    # copy symbols if available
    if (file.exists("symbols.rds"))
       file.copy("symbols.rds", dest, overwrite = TRUE)
-   
+
    # also copy to package 'libs' folder, for devtools
    libsDest <- paste0("../libs", R_ARCH)
    dir.create(libsDest, recursive = TRUE, showWarnings = FALSE)
    file.copy(files, libsDest, overwrite = TRUE)
-   
+
    # copy tbb (NOTE: do not use inst/ folder as R will resolve symlinks,
    # behavior which we do _not_ want here!)
    tbbDest <- file.path(R_PACKAGE_DIR, paste0("lib", R_ARCH))
    dir.create(tbbDest, recursive = TRUE, showWarnings = FALSE)
-   
+
    # note: on Linux, TBB gets compiled with extensions like
    # '.so.2', so be ready to handle those
    shlibPattern <- switch(
@@ -34,32 +34,32 @@
    if (R.version$os == "emscripten") {
       shlibPattern <- "^libtbb.*\\.a$"
    }
-   
+
    if (!nzchar(tbbLib)) {
-      
+
       # using bundled TBB
       tbbLibs <- list.files(
          path       = "tbb/build/lib_release",
          pattern    = shlibPattern,
          full.names = TRUE
       )
-      
+
       for (tbbLib in tbbLibs) {
          system2("cp", c("-P", shQuote(tbbLib), shQuote(tbbDest)))
       }
-      
+
    } else {
-      
+
       # using system tbb
       tbbLibs <- list.files(
          path       = tbbLib,
          pattern    = shlibPattern,
          full.names = TRUE
       )
-      
+
       # don't copy symlinks
       tbbLibs <- tbbLibs[!nzchar(Sys.readlink(tbbLibs))]
-      
+
       # copy / link the libraries
       useSymlinks <- Sys.getenv("TBB_USE_SYMLINKS", unset = .Platform$OS.type != "windows")
       if (useSymlinks) {
@@ -69,9 +69,9 @@
             system2("cp", c("-P", shQuote(tbbLib), shQuote(tbbDest)))
          }
       }
-      
+
    }
-   
+
    # on Windows, we create a stub library that links to us so that
    # older binaries (like rstan) can still load
    if (.Platform$OS.type == "windows") {
@@ -84,7 +84,7 @@
          file.copy("tbb-compat/tbb.dll", file.path(tbbDest, "tbb.dll"))
       }
    }
-   
+
 }
 
 useTbbPreamble <- function(tbbInc) {
@@ -102,22 +102,32 @@ useSystemTbb <- function(tbbLib, tbbInc) {
 }
 
 useBundledTbb <- function() {
-   
+
    useTbbPreamble("tbb/include")
    dir.create("tbb/build-tbb", showWarnings = FALSE)
-   
+
    cmake <- Sys.getenv("CMAKE", unset = "cmake")
    buildType <- Sys.getenv("CMAKE_BUILD_TYPE", unset = "Release")
    verbose <- Sys.getenv("VERBOSE", unset = "0")
 
+   splitCompilerVar("CC", "CFLAGS")
+   splitCompilerVar("CXX", "CXXFLAGS")
+
+   prependFlags("CPPFLAGS", "CFLAGS")
+   prependFlags("CPPFLAGS", "CXXFLAGS")
+
    cmakeFlags <- c(
-      sprintf("-DCMAKE_BUILD_TYPE=%s", buildType),
+      forwardEnvVar("CC", "CMAKE_C_COMPILER"),
+      forwardEnvVar("CXX", "CMAKE_CXX_COMPILER"),
+      forwardEnvVar("CFLAGS", "CMAKE_C_FLAGS"),
+      forwardEnvVar("CXXFLAGS", "CMAKE_CXX_FLAGS"),
+      forwardEnvVar("CMAKE_BUILD_TYPE", "CMAKE_BUILD_TYPE"),
       "-DTBB_TEST=0",
       "-DTBB_EXAMPLES=0",
       "-DTBB_STRICT=0",
       ".."
    )
-   
+
    if (R.version$os == "emscripten") {
       cmakeFlags <- c(
          "-DEMSCRIPTEN=1",
@@ -126,7 +136,7 @@ useBundledTbb <- function() {
          cmakeFlags
       )
    }
-   
+
    writeLines("*** configuring tbb")
    owd <- setwd("tbb/build-tbb")
    output <- system2(cmake, shQuote(cmakeFlags), stdout = TRUE, stderr = TRUE)
@@ -138,7 +148,12 @@ useBundledTbb <- function() {
       writeLines(output)
    }
    setwd(owd)
-   
+
+   if (!identical(verbose, "0")) {
+      writeLines("*** dumping CMakeCache.txt")
+      writeLines(readLines("tbb/build-tbb/CMakeCache.txt"))
+   }
+
    writeLines("*** building tbb")
    owd <- setwd("tbb/build-tbb")
    output <- system2(cmake, c("--build", ".", "--config", "release"), stdout = TRUE, stderr = TRUE)
@@ -150,34 +165,94 @@ useBundledTbb <- function() {
       writeLines(output)
    }
    setwd(owd)
-   
+
    shlibPattern <- switch(
       Sys.info()[["sysname"]],
       Windows = "^tbb.*\\.dll$",
       Darwin  = "^libtbb.*\\.dylib$",
       "^libtbb.*\\.so.*$"
    )
-   
+
    # WASM only supports static libraries
    if (R.version$os == "emscripten") {
       shlibPattern <- "^libtbb.*\\.a$"
    }
-   
+
    tbbFiles <- list.files(
       file.path(getwd(), "tbb/build-tbb"),
       pattern = shlibPattern,
       recursive = TRUE,
       full.names = TRUE
    )
-   
+
    dir.create("tbb/build/lib_release", recursive = TRUE, showWarnings = FALSE)
    file.copy(tbbFiles, "tbb/build/lib_release", overwrite = TRUE)
    unlink("tbb/build-tbb", recursive = TRUE)
    writeLines("*** finished building tbb")
-   
+
+}
+
+getenv <- function(key, unset = "") {
+   Sys.getenv(key, unset = unset)
+}
+
+
+setenv <- function(key, value) {
+   args <- list(paste(value, collapse = " "))
+   names(args) <- key
+   do.call(Sys.setenv, args)
 }
 
 
+# CMake doesn't support flags specified directly as part of the compiler
+# definition, so manually split it here.
+splitCompilerVar <- function(compilerVar, flagsVar) {
+
+   compiler <- Sys.getenv(compilerVar, unset = NA)
+   if (is.na(compiler))
+      return(FALSE)
+
+   tokens <- scan(text = compiler, what = character(), quiet = TRUE)
+   if (length(tokens) < 2L)
+      return(FALSE)
+
+   setenv(compilerVar, tokens[[1L]])
+
+   oldFlags <- Sys.getenv(flagsVar)
+   newFlags <- c(tokens[-1L], oldFlags)
+   setenv(flagsVar, newFlags[nzchar(newFlags)])
+
+   TRUE
+
+}
+
+
+# Given an environment variable like 'CC', forward that to CMake
+# via the corresponding CMAKE_C_COMPILER flag.
+forwardEnvVar <- function(envVar, cmakeVar) {
+   envVal <- Sys.getenv(envVar, unset = NA)
+   if (!is.na(envVal)) {
+      sprintf("-D%s=%s", cmakeVar, shQuote(envVal))
+   }
+}
+
+prependFlags <- function(prependFlags, toFlags) {
+
+   prependVal <- Sys.getenv(prependFlags, unset = NA)
+   if (is.na(prependVal))
+      return(FALSE)
+
+   oldVal <- Sys.getenv(toFlags, unset = NA)
+   if (is.na(oldVal)) {
+      setenv(toFlags, prependVal)
+   } else {
+      setenv(toFlags, paste(prependVal, oldVal))
+   }
+
+   TRUE
+
+}
+
 # Main ----
 
 tbbLib <- Sys.getenv("TBB_LIB")