install.libs.R 4.66 KB
Newer Older
Laurae's avatar
Laurae committed
1
2
# User options
use_precompile <- FALSE
3
4
use_gpu <- FALSE
use_mingw <- FALSE
Laurae's avatar
Laurae committed
5

6
if (.Machine$sizeof.pointer != 8L) {
Guolin Ke's avatar
Guolin Ke committed
7
8
9
  stop("Only support 64-bit R, please check your the version of your R and Rtools.")
}

10
R_int_UUID <- .Internal(internalsID())
11
R_ver <- as.double(R.Version()$major) + as.double(R.Version()$minor) / 10.0
12

13
if (!(R_int_UUID == "0310d4b8-ccb1-4bb8-ba94-d36a55f60262"
14
    || R_int_UUID == "2fdf6c18-697a-4ba7-b8ef-11c0d92f1327")) {
15
  print("Warning: unmatched R_INTERNALS_UUID, may cannot run normally.")
16
}
James Lamb's avatar
James Lamb committed
17
18

# Move in CMakeLists.txt
19
if (!file.copy("../inst/bin/CMakeLists.txt", "CMakeLists.txt", overwrite = TRUE)) {
James Lamb's avatar
James Lamb committed
20
21
22
  stop("Copying CMakeLists failed")
}

23
24
25
26
# Get some paths
source_dir <- file.path(R_PACKAGE_SOURCE, "src", fsep = "/")
build_dir <- file.path(source_dir, "build", fsep = "/")

Laurae's avatar
Laurae committed
27
28
29
30
# Check for precompilation
if (!use_precompile) {

  # Prepare building package
31
32
33
34
35
  dir.create(
    build_dir
    , recursive = TRUE
    , showWarnings = FALSE
  )
Laurae's avatar
Laurae committed
36
  setwd(build_dir)
37

38
  # Prepare installation steps
Guolin Ke's avatar
Guolin Ke committed
39
  cmake_cmd <- "cmake "
40
  build_cmd <- "make _lightgbm"
41
  lib_folder <- file.path(R_PACKAGE_SOURCE, "src", fsep = "/")
42

Guolin Ke's avatar
Guolin Ke committed
43
44
45
  if (use_gpu) {
    cmake_cmd <- paste0(cmake_cmd, " -DUSE_GPU=ON ")
  }
46
47
48
  if (R_ver >= 3.5) {
    cmake_cmd <- paste0(cmake_cmd, " -DUSE_R35=ON ")
  }
49
  cmake_cmd <- paste0(cmake_cmd, " -DBUILD_FOR_R=ON ")
Guolin Ke's avatar
Guolin Ke committed
50

51
  # Check if Windows installation (for gcc vs Visual Studio)
Laurae's avatar
Laurae committed
52
53
  if (WINDOWS) {
    if (use_mingw) {
Guolin Ke's avatar
Guolin Ke committed
54
      cmake_cmd <- paste0(cmake_cmd, " -G \"MinGW Makefiles\" ")
55
      build_cmd <- "mingw32-make.exe _lightgbm"
56
      system(paste0(cmake_cmd, " ..")) # Must build twice for Windows due sh.exe in Rtools
Laurae's avatar
Laurae committed
57
    } else {
58
      try_vs <- 0L
Guolin Ke's avatar
Guolin Ke committed
59
      local_vs_def <- ""
60
      vs_versions <- c("Visual Studio 16 2019", "Visual Studio 15 2017", "Visual Studio 14 2015")
61
      for (vs in vs_versions) {
62
        vs_def <- paste0(" -G \"", vs, "\" -A x64")
Guolin Ke's avatar
Guolin Ke committed
63
64
        tmp_cmake_cmd <- paste0(cmake_cmd, vs_def)
        try_vs <- system(paste0(tmp_cmake_cmd, " .."))
65
66
        if (try_vs == 0L) {
          local_vs_def <- vs_def
Guolin Ke's avatar
Guolin Ke committed
67
          break
68
69
        } else {
          unlink("./*", recursive = TRUE) # Clean up build directory
Guolin Ke's avatar
Guolin Ke committed
70
71
        }
      }
72
      if (try_vs == 1L) {
Guolin Ke's avatar
Guolin Ke committed
73
        cmake_cmd <- paste0(cmake_cmd, " -G \"MinGW Makefiles\" ") # Switch to MinGW on failure, try build once
74
        system(paste0(cmake_cmd, " ..")) # Must build twice for Windows due sh.exe in Rtools
75
        build_cmd <- "mingw32-make.exe _lightgbm"
76
      } else {
Guolin Ke's avatar
Guolin Ke committed
77
        cmake_cmd <- paste0(cmake_cmd, local_vs_def)
78
        build_cmd <- "cmake --build . --target _lightgbm --config Release"
79
80
        lib_folder <- file.path(R_PACKAGE_SOURCE, "src/Release", fsep = "/")
      }
81
82
    }
  }
83

Laurae's avatar
Laurae committed
84
85
  # Install
  system(paste0(cmake_cmd, " .."))
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

  # R CMD check complains about the .NOTPARALLEL directive created in the cmake
  # Makefile. We don't need it here anyway since targets are built serially, so trying
  # to remove it with this hack
  generated_makefile <- file.path(
    R_PACKAGE_SOURCE
    , "src"
    , "build"
    , "Makefile"
  )
  if (file.exists(generated_makefile)) {
    makefile_txt <- readLines(
      con = generated_makefile
    )
    makefile_txt <- gsub(
      pattern = ".*NOTPARALLEL.*"
      , replacement = ""
      , x = makefile_txt
    )
    writeLines(
      text = makefile_txt
      , con = generated_makefile
      , sep = "\n"
    )
  }

Laurae's avatar
Laurae committed
112
  system(build_cmd)
113
  src <- file.path(lib_folder, paste0("lib_lightgbm", SHLIB_EXT), fsep = "/")
114

Laurae's avatar
Laurae committed
115
} else {
116

Laurae's avatar
Laurae committed
117
  # Has precompiled package
118
  lib_folder <- file.path(R_PACKAGE_SOURCE, "../", fsep = "/")
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
  shared_object_file <- file.path(
    lib_folder
    , paste0("lib_lightgbm", SHLIB_EXT)
    , fsep = "/"
  )
  release_file <- file.path(
    lib_folder
    , paste0("Release/lib_lightgbm", SHLIB_EXT)
    , fsep = "/"
  )
  windows_shared_object_file <- file.path(
    lib_folder
    , paste0("/windows/x64/DLL/lib_lightgbm", SHLIB_EXT)
    , fsep = "/"
  )
  if (file.exists(shared_object_file)) {
    src <- shared_object_file
  } else if (file.exists(release_file)) {
    src <- release_file
Laurae's avatar
Laurae committed
138
  } else {
139
140
    # Expected result: installation will fail if it is not here or any other
    src <- windows_shared_object_file
141
142
143
  }
}

Laurae's avatar
Laurae committed
144
# Check installation correctness
145
dest <- file.path(R_PACKAGE_DIR, paste0("libs", R_ARCH), fsep = "/")
146
dir.create(dest, recursive = TRUE, showWarnings = FALSE)
Laurae's avatar
Laurae committed
147
if (file.exists(src)) {
148
  print(paste0("Found library file: ", src, " to move to ", dest))
149
150
  file.copy(src, dest, overwrite = TRUE)
} else {
Laurae's avatar
Laurae committed
151
  stop(paste0("Cannot find lib_lightgbm", SHLIB_EXT))
152
}
153
154
155
156
157
158
159
160
161
162

# clean up the "build" directory
if (dir.exists(build_dir)) {
  print("Removing 'build/' directory")
  unlink(
    x = file.path(R_PACKAGE_SOURCE, "src", "build")
    , recursive = TRUE
    , force = TRUE
  )
}