CMakeLists.txt 22.4 KB
Newer Older
1
2
3
4
5
6
option(USE_MPI "Enable MPI-based distributed learning" OFF)
option(USE_OPENMP "Enable OpenMP" ON)
option(USE_GPU "Enable GPU-accelerated training" OFF)
option(USE_SWIG "Enable SWIG to generate Java API" OFF)
option(USE_HDFS "Enable HDFS support (EXPERIMENTAL)" OFF)
option(USE_TIMETAG "Set to ON to output time costs" OFF)
7
option(USE_CUDA "Enable CUDA-accelerated training " OFF)
8
9
10
option(USE_DEBUG "Set to ON for Debug mode" OFF)
option(USE_SANITIZER "Use santizer flags" OFF)
set(
11
12
13
14
15
16
17
  ENABLED_SANITIZERS
  "address" "leak" "undefined"
  CACHE
  STRING
  "Semicolon separated list of sanitizer names, e.g., 'address;leak'. \
Supported sanitizers are address, leak, undefined and thread."
)
18
option(BUILD_CLI "Build the 'lightbgm' command-line interface in addition to lib_lightgbm" ON)
19
20
option(BUILD_CPP_TEST "Build C++ tests with Google Test" OFF)
option(BUILD_STATIC_LIB "Build static library" OFF)
21
22
option(INSTALL_HEADERS "Install headers to CMAKE_INSTALL_PREFIX (e.g. '/usr/local/include')" ON)
option(__BUILD_FOR_PYTHON "Set to ON if building lib_lightgbm for use with the Python package" OFF)
23
24
option(__BUILD_FOR_R "Set to ON if building lib_lightgbm for use with the R package" OFF)
option(__INTEGRATE_OPENCL "Set to ON if building LightGBM with the OpenCL ICD Loader and its dependencies included" OFF)
25

26
if(APPLE)
27
  option(APPLE_OUTPUT_DYLIB "Output dylib shared library" OFF)
28
endif()
29

30
cmake_minimum_required(VERSION 3.18)
Guolin Ke's avatar
Guolin Ke committed
31

32
project(lightgbm LANGUAGES C CXX)
Guolin Ke's avatar
Guolin Ke committed
33

34
35
36
37
38
39
40
if(BUILD_CPP_TEST)
  set(CMAKE_CXX_STANDARD 14)
else()
  set(CMAKE_CXX_STANDARD 11)
endif()
set(CMAKE_CXX_STANDARD_REQUIRED ON)

41
42
43
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules")

#-- Sanitizer
44
if(USE_SANITIZER)
45
46
  if(MSVC)
    message(FATAL_ERROR "Sanitizers are not supported with MSVC.")
47
  endif()
48
49
  include(cmake/Sanitizer.cmake)
  enable_sanitizers("${ENABLED_SANITIZERS}")
50
endif()
51

52
53
54
55
56
57
if(__INTEGRATE_OPENCL)
  set(__INTEGRATE_OPENCL ON CACHE BOOL "" FORCE)
  set(USE_GPU OFF CACHE BOOL "" FORCE)
  message(STATUS "Building library with integrated OpenCL components")
endif()

58
59
60
61
62
63
64
65
if(__BUILD_FOR_PYTHON OR __BUILD_FOR_R)
    # the Python and R package don't require the CLI
    set(BUILD_CLI OFF)
    # installing the R and Python package shouldn't place LightGBM's headers
    # outside of where the package is installed
    set(INSTALL_HEADERS OFF)
endif()

Qiwei Ye's avatar
Qiwei Ye committed
66
67
68
69
70
71
72
73
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "4.8.2")
    message(FATAL_ERROR "Insufficient gcc version")
  endif()
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "3.8")
    message(FATAL_ERROR "Insufficient Clang version")
  endif()
74
75
76
77
78
79
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "8.1.0")
    message(FATAL_ERROR "Insufficient AppleClang version")
  endif()
elseif(MSVC)
  if(MSVC_VERSION LESS 1900)
80
81
82
83
    message(
      FATAL_ERROR
      "The compiler ${CMAKE_CXX_COMPILER} doesn't support required C++11 features. Please use a newer MSVC."
    )
84
  endif()
85
endif()
Guolin Ke's avatar
Guolin Ke committed
86

87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
if(USE_SWIG)
  find_package(SWIG REQUIRED)
  find_package(Java REQUIRED)
  find_package(JNI REQUIRED)
  include(UseJava)
  include(UseSWIG)
  set(SWIG_CXX_EXTENSION "cxx")
  set(SWIG_EXTRA_LIBRARIES "")
  set(SWIG_JAVA_EXTRA_FILE_EXTENSIONS ".java" "JNI.java")
  set(SWIG_MODULE_JAVA_LANGUAGE "JAVA")
  set(SWIG_MODULE_JAVA_SWIG_LANGUAGE_FLAG "java")
  set(CMAKE_SWIG_OUTDIR "${CMAKE_CURRENT_BINARY_DIR}/java")
  include_directories(Java_INCLUDE_DIRS)
  include_directories(JNI_INCLUDE_DIRS)
  include_directories($ENV{JAVA_HOME}/include)
102
  if(WIN32)
103
      file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/com/microsoft/ml/lightgbm/windows/x86_64")
104
      include_directories($ENV{JAVA_HOME}/include/win32)
105
  elseif(APPLE)
106
      file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/com/microsoft/ml/lightgbm/osx/x86_64")
107
      include_directories($ENV{JAVA_HOME}/include/darwin)
108
  else()
109
      file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/com/microsoft/ml/lightgbm/linux/x86_64")
110
111
      include_directories($ENV{JAVA_HOME}/include/linux)
  endif()
112
endif()
113

114
set(EIGEN_DIR "${PROJECT_SOURCE_DIR}/external_libs/eigen")
115
116
include_directories(${EIGEN_DIR})

117
# See https://gitlab.com/libeigen/eigen/-/blob/master/COPYING.README
118
add_definitions(-DEIGEN_MPL2_ONLY)
119
add_definitions(-DEIGEN_DONT_PARALLELIZE)
120

121
if(__BUILD_FOR_R)
122
123
124
125
126
    find_package(LibR REQUIRED)
    message(STATUS "LIBR_EXECUTABLE: ${LIBR_EXECUTABLE}")
    message(STATUS "LIBR_INCLUDE_DIRS: ${LIBR_INCLUDE_DIRS}")
    message(STATUS "LIBR_CORE_LIBRARY: ${LIBR_CORE_LIBRARY}")
    include_directories(${LIBR_INCLUDE_DIRS})
127
    add_definitions(-DLGB_R_BUILD)
128
endif()
129

130
if(USE_TIMETAG)
131
    add_definitions(-DTIMETAG)
132
endif()
133

Guolin Ke's avatar
Guolin Ke committed
134
if(USE_DEBUG)
135
    add_definitions(-DDEBUG)
136
endif()
Guolin Ke's avatar
Guolin Ke committed
137

Guolin Ke's avatar
Guolin Ke committed
138
if(USE_MPI)
Guolin Ke's avatar
Guolin Ke committed
139
    find_package(MPI REQUIRED)
140
    add_definitions(-DUSE_MPI)
Guolin Ke's avatar
Guolin Ke committed
141
else()
142
    add_definitions(-DUSE_SOCKET)
143
endif()
Guolin Ke's avatar
Guolin Ke committed
144

145
if(USE_CUDA)
146
    set(CMAKE_CUDA_HOST_COMPILER "${CMAKE_CXX_COMPILER}")
147
    enable_language(CUDA)
148
    set(USE_OPENMP ON CACHE BOOL "CUDA requires OpenMP" FORCE)
149
endif()
150

151
if(USE_OPENMP)
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
    if(APPLE)
        find_package(OpenMP)
        if(NOT OpenMP_FOUND)
            # libomp 15.0+ from brew is keg-only, so have to search in other locations.
            # See https://github.com/Homebrew/homebrew-core/issues/112107#issuecomment-1278042927.
            execute_process(COMMAND brew --prefix libomp
                            OUTPUT_VARIABLE HOMEBREW_LIBOMP_PREFIX
                            OUTPUT_STRIP_TRAILING_WHITESPACE)
            set(OpenMP_C_FLAGS "-Xpreprocessor -fopenmp -I${HOMEBREW_LIBOMP_PREFIX}/include")
            set(OpenMP_CXX_FLAGS "-Xpreprocessor -fopenmp -I${HOMEBREW_LIBOMP_PREFIX}/include")
            set(OpenMP_C_LIB_NAMES omp)
            set(OpenMP_CXX_LIB_NAMES omp)
            set(OpenMP_omp_LIBRARY ${HOMEBREW_LIBOMP_PREFIX}/lib/libomp.dylib)
            find_package(OpenMP REQUIRED)
        endif()
    else()
        find_package(OpenMP REQUIRED)
    endif()
170
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
171
endif()
Guolin Ke's avatar
Guolin Ke committed
172

173
if(USE_GPU)
174
    set(BOOST_COMPUTE_HEADER_DIR ${PROJECT_SOURCE_DIR}/external_libs/compute/include)
175
    include_directories(${BOOST_COMPUTE_HEADER_DIR})
176
177
    find_package(OpenCL REQUIRED)
    include_directories(${OpenCL_INCLUDE_DIRS})
178
    message(STATUS "OpenCL include directory: " ${OpenCL_INCLUDE_DIRS})
179
    if(WIN32)
Guolin Ke's avatar
Guolin Ke committed
180
181
        set(Boost_USE_STATIC_LIBS ON)
    endif()
182
    find_package(Boost 1.56.0 COMPONENTS filesystem system REQUIRED)
183
    if(WIN32)
184
        # disable autolinking in boost
185
        add_definitions(-DBOOST_ALL_NO_LIB)
186
    endif()
Guolin Ke's avatar
Guolin Ke committed
187
    include_directories(${Boost_INCLUDE_DIRS})
188
    add_definitions(-DUSE_GPU)
189
endif()
190

191
if(__INTEGRATE_OPENCL)
192
193
194
    if(APPLE)
        message(FATAL_ERROR "Integrated OpenCL build is not available on macOS")
    else()
195
        include(cmake/IntegratedOpenCL.cmake)
196
        add_definitions(-DUSE_GPU)
197
198
    endif()
endif()
199

200
if(USE_CUDA)
201
    find_package(CUDA 11.0 REQUIRED)
202
    include_directories(${CUDA_INCLUDE_DIRS})
203
    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -Xcompiler=${OpenMP_CXX_FLAGS} -Xcompiler=-fPIC -Xcompiler=-Wall")
204

205
206
207
    # reference for mapping of CUDA toolkit component versions to supported architectures ("compute capabilities"):
    # https://en.wikipedia.org/wiki/CUDA#GPUs_supported
    set(CUDA_ARCHS "6.0" "6.1" "6.2" "7.0" "7.5")
208
209
210
211
212
213
    if(CUDA_VERSION VERSION_GREATER_EQUAL "11.0")
        list(APPEND CUDA_ARCHS "8.0")
    endif()
    if(CUDA_VERSION VERSION_GREATER_EQUAL "11.1")
        list(APPEND CUDA_ARCHS "8.6")
    endif()
214
215
216
217
218
219
    if(CUDA_VERSION VERSION_GREATER_EQUAL "11.5")
        list(APPEND CUDA_ARCHS "8.7")
    endif()
    if(CUDA_VERSION VERSION_GREATER_EQUAL "11.8")
        list(APPEND CUDA_ARCHS "9.0")
    endif()
220
221
    list(POP_BACK CUDA_ARCHS CUDA_LAST_SUPPORTED_ARCH)
    list(APPEND CUDA_ARCHS "${CUDA_LAST_SUPPORTED_ARCH}+PTX")
222
    cuda_select_nvcc_arch_flags(CUDA_ARCH_FLAGS ${CUDA_ARCHS})
223
    string(REPLACE ";" " " CUDA_ARCH_FLAGS "${CUDA_ARCH_FLAGS}")
224

225
    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} ${CUDA_ARCH_FLAGS}")
226
    if(USE_DEBUG)
227
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -g")
228
    else()
229
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -O3 -lineinfo")
230
231
232
    endif()
    message(STATUS "CMAKE_CUDA_FLAGS: ${CMAKE_CUDA_FLAGS}")

233
    add_definitions(-DUSE_CUDA)
234

235
    if(NOT DEFINED CMAKE_CUDA_STANDARD)
236
237
238
239
      set(CMAKE_CUDA_STANDARD 11)
      set(CMAKE_CUDA_STANDARD_REQUIRED ON)
    endif()

240
241
242
243
    set(
      BASE_DEFINES
      -DPOWER_FEATURE_WORKGROUPS=12
      -DUSE_CONSTANT_BUF=0
244
    )
245
246
247
248
    set(
      ALLFEATS_DEFINES
      ${BASE_DEFINES}
      -DENABLE_ALL_FEATURES
249
    )
250
251
252
253
    set(
      FULLDATA_DEFINES
      ${ALLFEATS_DEFINES}
      -DIGNORE_INDICES
254
255
256
257
258
259
260
261
    )

    message(STATUS "ALLFEATS_DEFINES: ${ALLFEATS_DEFINES}")
    message(STATUS "FULLDATA_DEFINES: ${FULLDATA_DEFINES}")

    function(add_histogram hsize hname hadd hconst hdir)
      add_library(histo${hsize}${hname} OBJECT src/treelearner/kernels/histogram${hsize}.cu)
      set_target_properties(histo${hsize}${hname} PROPERTIES CUDA_SEPARABLE_COMPILATION ON)
262
      set_target_properties(histo${hsize}${hname} PROPERTIES CUDA_ARCHITECTURES OFF)
263
264
265
266
267
      if(hadd)
        list(APPEND histograms histo${hsize}${hname})
        set(histograms ${histograms} PARENT_SCOPE)
      endif()
      target_compile_definitions(
268
269
        histo${hsize}${hname}
        PRIVATE
270
271
272
273
274
        -DCONST_HESSIAN=${hconst}
        ${hdir}
      )
    endfunction()

275
    foreach(hsize _16_64_256)
276
277
278
279
280
281
282
      add_histogram("${hsize}" "_sp_const" "True" "1" "${BASE_DEFINES}")
      add_histogram("${hsize}" "_sp" "True" "0" "${BASE_DEFINES}")
      add_histogram("${hsize}" "-allfeats_sp_const" "False" "1" "${ALLFEATS_DEFINES}")
      add_histogram("${hsize}" "-allfeats_sp" "False" "0" "${ALLFEATS_DEFINES}")
      add_histogram("${hsize}" "-fulldata_sp_const" "True" "1" "${FULLDATA_DEFINES}")
      add_histogram("${hsize}" "-fulldata_sp" "True" "0" "${FULLDATA_DEFINES}")
    endforeach()
283
endif()
284

285
286
287
288
289
if(USE_HDFS)
    find_package(JNI REQUIRED)
    find_path(HDFS_INCLUDE_DIR hdfs.h REQUIRED)
    find_library(HDFS_LIB NAMES hdfs REQUIRED)
    include_directories(${HDFS_INCLUDE_DIR})
290
291
    add_definitions(-DUSE_HDFS)
    set(HDFS_CXX_LIBRARIES ${HDFS_LIB} ${JAVA_JVM_LIBRARY})
292
endif()
293

294
295
296
297
298
299
300
301
302
303
304
include(CheckCXXSourceCompiles)
check_cxx_source_compiles("
#include <xmmintrin.h>
int main() {
  int a = 0;
  _mm_prefetch(&a, _MM_HINT_NTA);
  return 0;
}
" MM_PREFETCH)

if(${MM_PREFETCH})
305
  message(STATUS "Using _mm_prefetch")
306
  add_definitions(-DMM_PREFETCH)
307
308
endif()

309
310
311
312
313
314
315
316
317
318
319
include(CheckCXXSourceCompiles)
check_cxx_source_compiles("
#include <mm_malloc.h>
int main() {
  char *a = (char*)_mm_malloc(8, 16);
  _mm_free(a);
  return 0;
}
" MM_MALLOC)

if(${MM_MALLOC})
320
  message(STATUS "Using _mm_malloc")
321
  add_definitions(-DMM_MALLOC)
322
323
endif()

Guolin Ke's avatar
Guolin Ke committed
324
if(UNIX OR MINGW OR CYGWIN)
325
  set(
326
    CMAKE_CXX_FLAGS
327
    "${CMAKE_CXX_FLAGS} -pthread -Wextra -Wall -Wno-ignored-attributes -Wno-unknown-pragmas -Wno-return-type"
328
  )
329
330
331
332
333
334
335
  if(MINGW)
    # ignore this warning: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=95353
    set(
      CMAKE_CXX_FLAGS
      "${CMAKE_CXX_FLAGS} -Wno-stringop-overflow"
    )
  endif()
336
  if(USE_DEBUG)
337
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -O0")
338
  else()
339
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
340
341
  endif()
  if(USE_SWIG)
342
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-strict-aliasing")
343
344
  endif()
  if(NOT USE_OPENMP)
345
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unknown-pragmas -Wno-unused-private-field")
346
347
  endif()
  if(__BUILD_FOR_R AND CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
348
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-cast-function-type")
349
  endif()
Guolin Ke's avatar
Guolin Ke committed
350
351
endif()

Nikita Titov's avatar
Nikita Titov committed
352
if(WIN32 AND MINGW)
353
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -static-libstdc++")
Nikita Titov's avatar
Nikita Titov committed
354
355
endif()

356
357
358
359
360
361
362
363
364
365
366
367
# Check if inet_pton is already available, to avoid conflicts with the implementation in LightGBM.
# As of 2022, MinGW started including a definition of inet_pton.
if(WIN32)
  include(CheckSymbolExists)
  list(APPEND CMAKE_REQUIRED_LIBRARIES "ws2_32")
  check_symbol_exists(inet_pton "ws2tcpip.h" WIN_INET_PTON_FOUND)
  if(WIN_INET_PTON_FOUND)
    add_definitions(-DWIN_HAS_INET_PTON)
  endif()
  list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES "ws2_32")
endif()

Guolin Ke's avatar
Guolin Ke committed
368
if(MSVC)
369
    set(
370
      variables
Guolin Ke's avatar
Guolin Ke committed
371
372
373
374
375
376
377
378
379
        CMAKE_C_FLAGS_DEBUG
        CMAKE_C_FLAGS_MINSIZEREL
        CMAKE_C_FLAGS_RELEASE
        CMAKE_C_FLAGS_RELWITHDEBINFO
        CMAKE_CXX_FLAGS_DEBUG
        CMAKE_CXX_FLAGS_MINSIZEREL
        CMAKE_CXX_FLAGS_RELEASE
        CMAKE_CXX_FLAGS_RELWITHDEBINFO
    )
380
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4 /MP")
381
382
383
384
385
386
387
    if(__BUILD_FOR_R)
        # MSVC does not like this commit:
        # https://github.com/wch/r-source/commit/fb52ac1a610571fcb8ac92d886b9fefcffaa7d48
        #
        # and raises "error C3646: 'private_data_c': unknown override specifier"
        add_definitions(-DR_LEGACY_RCOMPLEX)
    endif()
Guolin Ke's avatar
Guolin Ke committed
388
    if(USE_DEBUG)
389
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Od")
Guolin Ke's avatar
Guolin Ke committed
390
    else()
391
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /O2 /Ob2 /Oi /Ot /Oy")
Guolin Ke's avatar
Guolin Ke committed
392
    endif()
Guolin Ke's avatar
Guolin Ke committed
393
else()
394
395
396
    if(NOT BUILD_STATIC_LIB)
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
    endif()
Guolin Ke's avatar
Guolin Ke committed
397
    if(NOT USE_DEBUG)
398
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -funroll-loops")
Guolin Ke's avatar
Guolin Ke committed
399
    endif()
400
endif()
Guolin Ke's avatar
Guolin Ke committed
401

402
set(LightGBM_HEADER_DIR ${PROJECT_SOURCE_DIR}/include)
Guolin Ke's avatar
Guolin Ke committed
403

404
405
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
Guolin Ke's avatar
Guolin Ke committed
406

407
include_directories(${LightGBM_HEADER_DIR})
Guolin Ke's avatar
Guolin Ke committed
408
409

if(APPLE)
410
  if(APPLE_OUTPUT_DYLIB)
411
    set(CMAKE_SHARED_LIBRARY_SUFFIX ".dylib")
412
  else()
413
    set(CMAKE_SHARED_LIBRARY_SUFFIX ".so")
414
  endif()
415
endif()
Guolin Ke's avatar
Guolin Ke committed
416
417
418

if(USE_MPI)
  include_directories(${MPI_CXX_INCLUDE_PATH})
419
endif()
Guolin Ke's avatar
Guolin Ke committed
420

421
422
423
424
425
426
427
428
429
file(
    GLOB
    SOURCES
      src/boosting/*.cpp
      src/io/*.cpp
      src/metric/*.cpp
      src/objective/*.cpp
      src/network/*.cpp
      src/treelearner/*.cpp
430
      src/utils/*.cpp
431
if(USE_CUDA)
432
      src/treelearner/*.cu
433
434
      src/boosting/cuda/*.cpp
      src/boosting/cuda/*.cu
435
436
      src/metric/cuda/*.cpp
      src/metric/cuda/*.cu
437
438
      src/objective/cuda/*.cpp
      src/objective/cuda/*.cu
439
440
441
442
443
444
445
      src/treelearner/cuda/*.cpp
      src/treelearner/cuda/*.cu
      src/io/cuda/*.cu
      src/io/cuda/*.cpp
      src/cuda/*.cpp
      src/cuda/*.cu
endif()
Guolin Ke's avatar
Guolin Ke committed
446
447
)

448
449
add_library(lightgbm_objs OBJECT ${SOURCES})

450
451
452
453
if(BUILD_CLI)
    add_executable(lightgbm src/main.cpp src/application/application.cpp)
    target_link_libraries(lightgbm PRIVATE lightgbm_objs)
endif()
454

455
set(API_SOURCES "src/c_api.cpp")
456
457
# Only build the R part of the library if building for
# use with the R package
458
if(__BUILD_FOR_R)
459
  list(APPEND API_SOURCES "src/lightgbm_R.cpp")
460
endif()
461

462
463
add_library(lightgbm_capi_objs OBJECT ${API_SOURCES})

464
if(BUILD_STATIC_LIB)
465
  add_library(_lightgbm STATIC)
466
else()
467
  add_library(_lightgbm SHARED)
468
endif()
469
# LightGBM headers include openmp, cuda, R etc. headers,
470
471
# thus PUBLIC is required for building _lightgbm_swig target.
target_link_libraries(_lightgbm PUBLIC lightgbm_capi_objs lightgbm_objs)
472

473
if(MSVC)
474
  set_target_properties(_lightgbm PROPERTIES OUTPUT_NAME "lib_lightgbm")
475
endif()
476

477
478
if(USE_SWIG)
  set_property(SOURCE swig/lightgbmlib.i PROPERTY CPLUSPLUS ON)
479
  list(APPEND swig_options -package com.microsoft.ml.lightgbm)
480
  set_property(SOURCE swig/lightgbmlib.i PROPERTY SWIG_FLAGS "${swig_options}")
481
  swig_add_library(_lightgbm_swig LANGUAGE java SOURCES swig/lightgbmlib.i)
482
  swig_link_libraries(_lightgbm_swig _lightgbm)
483
  # needed to ensure Linux build does not have lib prefix specified twice, e.g. liblib_lightgbm_swig
484
  set_target_properties(_lightgbm_swig PROPERTIES PREFIX "")
485
  # needed in some versions of CMake for VS and MinGW builds to ensure output dll has lib prefix
486
487
488
  set_target_properties(_lightgbm_swig PROPERTIES OUTPUT_NAME "lib_lightgbm_swig")
  if(WIN32)
    if(MINGW OR CYGWIN)
489
490
491
        add_custom_command(
            TARGET _lightgbm_swig
            POST_BUILD
492
            COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
493
494
495
496
497
498
499
500
501
502
503
504
505
506
            COMMAND
              "${CMAKE_COMMAND}"
              -E
              copy_if_different
              "${PROJECT_SOURCE_DIR}/lib_lightgbm.dll"
              com/microsoft/ml/lightgbm/windows/x86_64
            COMMAND
              "${CMAKE_COMMAND}"
              -E
              copy_if_different
              "${PROJECT_SOURCE_DIR}/lib_lightgbm_swig.dll"
              com/microsoft/ml/lightgbm/windows/x86_64
            COMMAND "${Java_JAR_EXECUTABLE}" -cf lightgbmlib.jar com
        )
507
    else()
508
509
510
        add_custom_command(
            TARGET _lightgbm_swig
            POST_BUILD
511
            COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
512
513
514
515
516
517
518
519
520
521
522
523
            COMMAND
              "${CMAKE_COMMAND}"
              -E
              copy_if_different
              "${PROJECT_SOURCE_DIR}/Release/lib_lightgbm.dll"
              com/microsoft/ml/lightgbm/windows/x86_64
            COMMAND
              "${CMAKE_COMMAND}"
              -E
              copy_if_different
              "${PROJECT_SOURCE_DIR}/Release/lib_lightgbm_swig.dll"
              com/microsoft/ml/lightgbm/windows/x86_64
524
525
            COMMAND "${Java_JAR_EXECUTABLE}" -cf lightgbmlib.jar com
        )
526
    endif()
527
  elseif(APPLE)
528
529
530
531
532
    add_custom_command(
        TARGET _lightgbm_swig
        POST_BUILD
        COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
        COMMAND
533
534
535
536
537
538
539
540
541
          "${CMAKE_COMMAND}"
          -E
          copy_if_different
          "${PROJECT_SOURCE_DIR}/lib_lightgbm.dylib"
          com/microsoft/ml/lightgbm/osx/x86_64
        COMMAND
          "${CMAKE_COMMAND}"
          -E
          copy_if_different
542
543
544
545
          "${PROJECT_SOURCE_DIR}/lib_lightgbm_swig.jnilib"
          com/microsoft/ml/lightgbm/osx/x86_64/lib_lightgbm_swig.dylib
        COMMAND "${Java_JAR_EXECUTABLE}" -cf lightgbmlib.jar com
    )
546
  else()
547
548
549
550
    add_custom_command(
        TARGET _lightgbm_swig
        POST_BUILD
        COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
551
552
553
554
555
556
        COMMAND
          "${CMAKE_COMMAND}"
          -E
          copy_if_different
          "${PROJECT_SOURCE_DIR}/lib_lightgbm.so"
          com/microsoft/ml/lightgbm/linux/x86_64
557
558
        COMMAND "${Java_JAR_EXECUTABLE}" -cf lightgbmlib.jar com
    )
559
  endif()
560
endif()
Guolin Ke's avatar
Guolin Ke committed
561
562

if(USE_MPI)
563
  target_link_libraries(lightgbm_objs PUBLIC ${MPI_CXX_LIBRARIES})
564
endif()
Guolin Ke's avatar
Guolin Ke committed
565

fanliwen's avatar
fanliwen committed
566
if(USE_OPENMP)
567
568
569
570
571
572
573
574
575
576
  if(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
    target_link_libraries(lightgbm_objs PUBLIC OpenMP::OpenMP_CXX)
    # c_api headers also includes OpenMP headers, thus compiling
    # lightgbm_capi_objs needs include directory for OpenMP.
    # Specifying OpenMP in target_link_libraries will get include directory
    # requirements for compilation.
    # This uses CMake's Transitive Usage Requirements. Refer to CMake doc:
    # https://cmake.org/cmake/help/v3.16/manual/cmake-buildsystem.7.html#transitive-usage-requirements
    target_link_libraries(lightgbm_capi_objs PUBLIC OpenMP::OpenMP_CXX)
  endif()
577
endif()
fanliwen's avatar
fanliwen committed
578

579
if(USE_GPU)
580
  target_link_libraries(lightgbm_objs PUBLIC ${OpenCL_LIBRARY} ${Boost_LIBRARIES})
581
endif()
582

583
if(__INTEGRATE_OPENCL)
584
  # targets OpenCL and Boost are added in IntegratedOpenCL.cmake
585
  add_dependencies(lightgbm_objs OpenCL Boost)
586
  # variables INTEGRATED_OPENCL_* are set in IntegratedOpenCL.cmake
587
588
  target_include_directories(lightgbm_objs PRIVATE ${INTEGRATED_OPENCL_INCLUDES})
  target_compile_definitions(lightgbm_objs PRIVATE ${INTEGRATED_OPENCL_DEFINITIONS})
589
  target_link_libraries(lightgbm_objs PUBLIC ${INTEGRATED_OPENCL_LIBRARIES} ${CMAKE_DL_LIBS})
590
591
endif()

592
if(USE_CUDA)
593
594
595
596
597
  # Disable cmake warning about policy CMP0104. Refer to issue #3754 and PR #4268.
  # Custom target properties does not propagate, thus we need to specify for
  # each target that contains or depends on cuda source.
  set_target_properties(lightgbm_objs PROPERTIES CUDA_ARCHITECTURES OFF)
  set_target_properties(_lightgbm PROPERTIES CUDA_ARCHITECTURES OFF)
598
599
600
  if(BUILD_CLI)
    set_target_properties(lightgbm PROPERTIES CUDA_ARCHITECTURES OFF)
  endif()
601

602
603
  set_target_properties(lightgbm_objs PROPERTIES CUDA_SEPARABLE_COMPILATION ON)

604
605
  # Device linking is not supported for object libraries.
  # Thus we have to specify them on final targets.
606
607
608
  if(BUILD_CLI)
    set_target_properties(lightgbm PROPERTIES CUDA_RESOLVE_DEVICE_SYMBOLS ON)
  endif()
609
  set_target_properties(_lightgbm PROPERTIES CUDA_RESOLVE_DEVICE_SYMBOLS ON)
610
611
612
613

  # histograms are list of object libraries. Linking object library to other
  # object libraries only gets usage requirements, the linked objects won't be
  # used. Thus we have to call target_link_libraries on final targets here.
614
615
616
  if(BUILD_CLI)
    target_link_libraries(lightgbm PRIVATE ${histograms})
  endif()
617
  target_link_libraries(_lightgbm PRIVATE ${histograms})
618
endif()
619

620
if(USE_HDFS)
621
  target_link_libraries(lightgbm_objs PUBLIC ${HDFS_CXX_LIBRARIES})
622
endif()
623

624
625
if(WIN32)
    if(MINGW OR CYGWIN)
626
      target_link_libraries(lightgbm_objs PUBLIC ws2_32 iphlpapi)
627
628
    endif()
endif()
Guolin Ke's avatar
Guolin Ke committed
629

630
if(__BUILD_FOR_R)
631
632
  # utils/log.h and capi uses R headers, thus both object libraries need to link
  # with R lib.
633
  if(MSVC)
634
    set(R_LIB ${LIBR_MSVC_CORE_LIBRARY})
635
  else()
636
    set(R_LIB ${LIBR_CORE_LIBRARY})
637
  endif()
638
639
  target_link_libraries(lightgbm_objs PUBLIC ${R_LIB})
  target_link_libraries(lightgbm_capi_objs PUBLIC ${R_LIB})
640
endif()
641

642
643
644
645
646
647
648
649
650
#-- Google C++ tests
if(BUILD_CPP_TEST)
  find_package(GTest CONFIG)
  if(NOT GTEST_FOUND)
    message(STATUS "Did not find Google Test in the system root. Fetching Google Test now...")
    include(FetchContent)
    FetchContent_Declare(
      googletest
      GIT_REPOSITORY https://github.com/google/googletest.git
651
      GIT_TAG        v1.14.0
652
653
654
655
    )
    FetchContent_MakeAvailable(googletest)
    add_library(GTest::GTest ALIAS gtest)
  endif()
656
657
658
659

  set(LightGBM_TEST_HEADER_DIR ${PROJECT_SOURCE_DIR}/tests/cpp_tests)
  include_directories(${LightGBM_TEST_HEADER_DIR})

660
661
  file(GLOB CPP_TEST_SOURCES tests/cpp_tests/*.cpp)
  if(MSVC)
June Liu's avatar
June Liu committed
662
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /permissive-")
663
664
665
666
667
668
669
670
671
672
673
674
    set(
      CompilerFlags
        CMAKE_CXX_FLAGS
        CMAKE_CXX_FLAGS_DEBUG
        CMAKE_CXX_FLAGS_RELEASE
        CMAKE_C_FLAGS
        CMAKE_C_FLAGS_DEBUG
        CMAKE_C_FLAGS_RELEASE
    )
    foreach(CompilerFlag ${CompilerFlags})
      string(REPLACE "/MD" "/MT" ${CompilerFlag} "${${CompilerFlag}}")
    endforeach()
675
  endif()
676
  add_executable(testlightgbm ${CPP_TEST_SOURCES})
677
  target_link_libraries(testlightgbm PRIVATE lightgbm_objs lightgbm_capi_objs GTest::GTest)
678
679
endif()

680
681
682
683
684
685
686
if(BUILD_CLI)
    install(
      TARGETS lightgbm
      RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
    )
endif()

687
688
689
690
if(__BUILD_FOR_PYTHON)
    set(CMAKE_INSTALL_PREFIX "lightgbm")
endif()

691
install(
692
  TARGETS _lightgbm
693
694
695
696
  RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
  LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
  ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
)
697

698
699
700
if(INSTALL_HEADERS)
    install(DIRECTORY ${LightGBM_HEADER_DIR}/LightGBM DESTINATION ${CMAKE_INSTALL_PREFIX}/include)
endif()