CMakeLists.txt 20.6 KB
Newer Older
1
2
3
4
5
6
7
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)
option(USE_CUDA "Enable CUDA-accelerated training (EXPERIMENTAL)" OFF)
8
option(USE_CUDA_EXP "Enable CUDA-accelerated training with more acceleration (EXPERIMENTAL)" OFF)
9
10
11
option(USE_DEBUG "Set to ON for Debug mode" OFF)
option(USE_SANITIZER "Use santizer flags" OFF)
set(
12
13
14
15
16
17
18
  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."
)
19
20
21
22
option(BUILD_CPP_TEST "Build C++ tests with Google Test" OFF)
option(BUILD_STATIC_LIB "Build static library" OFF)
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)
23

24
if(APPLE)
25
  option(APPLE_OUTPUT_DYLIB "Output dylib shared library" OFF)
26
endif()
27

28
29
30
if(__INTEGRATE_OPENCL)
  cmake_minimum_required(VERSION 3.11)
elseif(USE_GPU OR APPLE)
31
  cmake_minimum_required(VERSION 3.2)
32
elseif(USE_CUDA OR USE_CUDA_EXP)
33
  cmake_minimum_required(VERSION 3.16)
34
else()
35
  cmake_minimum_required(VERSION 3.0)
36
endif()
Guolin Ke's avatar
Guolin Ke committed
37

38
project(lightgbm LANGUAGES C CXX)
Guolin Ke's avatar
Guolin Ke committed
39

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

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

51
52
53
54
55
56
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()

Qiwei Ye's avatar
Qiwei Ye committed
57
58
59
60
61
62
63
64
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()
65
66
67
68
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "8.1.0")
    message(FATAL_ERROR "Insufficient AppleClang version")
  endif()
69
  cmake_minimum_required(VERSION 3.16)
70
71
elseif(MSVC)
  if(MSVC_VERSION LESS 1900)
72
73
74
75
    message(
      FATAL_ERROR
      "The compiler ${CMAKE_CXX_COMPILER} doesn't support required C++11 features. Please use a newer MSVC."
    )
76
77
  endif()
  cmake_minimum_required(VERSION 3.8)
78
endif()
Guolin Ke's avatar
Guolin Ke committed
79

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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)
95
  if(WIN32)
96
      file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/com/microsoft/ml/lightgbm/windows/x86_64")
97
      include_directories($ENV{JAVA_HOME}/include/win32)
98
  elseif(APPLE)
99
      file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/com/microsoft/ml/lightgbm/osx/x86_64")
100
      include_directories($ENV{JAVA_HOME}/include/darwin)
101
  else()
102
      file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/com/microsoft/ml/lightgbm/linux/x86_64")
103
104
      include_directories($ENV{JAVA_HOME}/include/linux)
  endif()
105
endif()
106

107
set(EIGEN_DIR "${PROJECT_SOURCE_DIR}/external_libs/eigen")
108
109
include_directories(${EIGEN_DIR})

110
# See https://gitlab.com/libeigen/eigen/-/blob/master/COPYING.README
111
add_definitions(-DEIGEN_MPL2_ONLY)
112
add_definitions(-DEIGEN_DONT_PARALLELIZE)
113

114
if(__BUILD_FOR_R)
115
116
117
118
119
    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})
120
    add_definitions(-DLGB_R_BUILD)
121
endif()
122

123
if(USE_TIMETAG)
124
    add_definitions(-DTIMETAG)
125
endif()
126

Guolin Ke's avatar
Guolin Ke committed
127
if(USE_DEBUG)
128
    add_definitions(-DDEBUG)
129
endif()
Guolin Ke's avatar
Guolin Ke committed
130

Guolin Ke's avatar
Guolin Ke committed
131
if(USE_MPI)
Guolin Ke's avatar
Guolin Ke committed
132
    find_package(MPI REQUIRED)
133
    add_definitions(-DUSE_MPI)
Guolin Ke's avatar
Guolin Ke committed
134
else()
135
    add_definitions(-DUSE_SOCKET)
136
endif()
Guolin Ke's avatar
Guolin Ke committed
137

138
if(USE_CUDA OR USE_CUDA_EXP)
139
    set(CMAKE_CUDA_HOST_COMPILER "${CMAKE_CXX_COMPILER}")
140
    enable_language(CUDA)
141
    set(USE_OPENMP ON CACHE BOOL "CUDA requires OpenMP" FORCE)
142
endif()
143

144
if(USE_OPENMP)
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    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()
163
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
164
endif()
Guolin Ke's avatar
Guolin Ke committed
165

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

184
185
if(__INTEGRATE_OPENCL)
    if(WIN32)
186
        include(cmake/IntegratedOpenCL.cmake)
187
        add_definitions(-DUSE_GPU)
188
189
    else()
        message(FATAL_ERROR "Integrated OpenCL build is available only for Windows")
190
191
    endif()
endif()
192

193
194
195
196
197
198
if(USE_CUDA OR USE_CUDA_EXP)
    if(USE_CUDA)
      find_package(CUDA 9.0 REQUIRED)
    else()
      find_package(CUDA 10.0 REQUIRED)
    endif()
199
    include_directories(${CUDA_INCLUDE_DIRS})
200
    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -Xcompiler=${OpenMP_CXX_FLAGS} -Xcompiler=-fPIC -Xcompiler=-Wall")
201
202
203
204
205

    set(CUDA_ARCHS "6.0" "6.1" "6.2" "7.0")
    if(CUDA_VERSION VERSION_GREATER_EQUAL "10.0")
        list(APPEND CUDA_ARCHS "7.5")
    endif()
206
207
208
209
210
211
    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()
212
213
    list(POP_BACK CUDA_ARCHS CUDA_LAST_SUPPORTED_ARCH)
    list(APPEND CUDA_ARCHS "${CUDA_LAST_SUPPORTED_ARCH}+PTX")
214
    cuda_select_nvcc_arch_flags(CUDA_ARCH_FLAGS ${CUDA_ARCHS})
215
    string(REPLACE ";" " " CUDA_ARCH_FLAGS "${CUDA_ARCH_FLAGS}")
216

217
    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} ${CUDA_ARCH_FLAGS}")
218
    if(USE_DEBUG)
219
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -g")
220
    else()
221
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -O3 -lineinfo")
222
223
224
    endif()
    message(STATUS "CMAKE_CUDA_FLAGS: ${CMAKE_CUDA_FLAGS}")

225
226
227
228
229
230
    if(USE_CUDA)
      add_definitions(-DUSE_CUDA)
    elseif(USE_CUDA_EXP)
      add_definitions(-DUSE_CUDA_EXP)
    endif()

231
    if(NOT DEFINED CMAKE_CUDA_STANDARD)
232
233
234
235
      set(CMAKE_CUDA_STANDARD 11)
      set(CMAKE_CUDA_STANDARD_REQUIRED ON)
    endif()

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

    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)
258
      set_target_properties(histo${hsize}${hname} PROPERTIES CUDA_ARCHITECTURES OFF)
259
260
261
262
263
      if(hadd)
        list(APPEND histograms histo${hsize}${hname})
        set(histograms ${histograms} PARENT_SCOPE)
      endif()
      target_compile_definitions(
264
265
        histo${hsize}${hname}
        PRIVATE
266
267
268
269
270
        -DCONST_HESSIAN=${hconst}
        ${hdir}
      )
    endfunction()

271
    foreach(hsize _16_64_256)
272
273
274
275
276
277
278
      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()
279
endif()
280

281
282
283
284
285
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})
286
287
    add_definitions(-DUSE_HDFS)
    set(HDFS_CXX_LIBRARIES ${HDFS_LIB} ${JAVA_JVM_LIBRARY})
288
endif()
289

290
291
292
293
294
295
296
297
298
299
300
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})
301
  message(STATUS "Using _mm_prefetch")
302
  add_definitions(-DMM_PREFETCH)
303
304
endif()

305
306
307
308
309
310
311
312
313
314
315
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})
316
  message(STATUS "Using _mm_malloc")
317
  add_definitions(-DMM_MALLOC)
318
319
endif()

Guolin Ke's avatar
Guolin Ke committed
320
if(UNIX OR MINGW OR CYGWIN)
321
  set(
322
323
324
325
    CMAKE_CXX_FLAGS
    "${CMAKE_CXX_FLAGS} -std=c++11 -pthread -Wextra -Wall -Wno-ignored-attributes -Wno-unknown-pragmas -Wno-return-type"
  )
  if(USE_DEBUG)
326
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -O0")
327
  else()
328
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
329
330
  endif()
  if(USE_SWIG)
331
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-strict-aliasing")
332
333
  endif()
  if(NOT USE_OPENMP)
334
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unknown-pragmas -Wno-unused-private-field")
335
336
  endif()
  if(__BUILD_FOR_R AND CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
337
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-cast-function-type")
338
  endif()
Guolin Ke's avatar
Guolin Ke committed
339
340
endif()

Nikita Titov's avatar
Nikita Titov committed
341
if(WIN32 AND MINGW)
342
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -static-libstdc++")
Nikita Titov's avatar
Nikita Titov committed
343
344
endif()

345
346
347
348
349
350
351
352
353
354
355
356
# 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
357
if(MSVC)
358
    set(
359
      variables
Guolin Ke's avatar
Guolin Ke committed
360
361
362
363
364
365
366
367
368
        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
    )
369
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4 /MP")
Guolin Ke's avatar
Guolin Ke committed
370
    if(USE_DEBUG)
371
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Od")
Guolin Ke's avatar
Guolin Ke committed
372
    else()
373
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /O2 /Ob2 /Oi /Ot /Oy")
Guolin Ke's avatar
Guolin Ke committed
374
    endif()
Guolin Ke's avatar
Guolin Ke committed
375
else()
376
377
378
    if(NOT BUILD_STATIC_LIB)
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
    endif()
Guolin Ke's avatar
Guolin Ke committed
379
    if(NOT USE_DEBUG)
380
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -funroll-loops")
Guolin Ke's avatar
Guolin Ke committed
381
    endif()
382
endif()
Guolin Ke's avatar
Guolin Ke committed
383

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

386
387
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
Guolin Ke's avatar
Guolin Ke committed
388

389
include_directories(${LightGBM_HEADER_DIR})
Guolin Ke's avatar
Guolin Ke committed
390
391

if(APPLE)
392
  if(APPLE_OUTPUT_DYLIB)
393
    set(CMAKE_SHARED_LIBRARY_SUFFIX ".dylib")
394
  else()
395
    set(CMAKE_SHARED_LIBRARY_SUFFIX ".so")
396
  endif()
397
endif()
Guolin Ke's avatar
Guolin Ke committed
398
399
400

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

403
404
405
406
407
408
409
410
411
file(
    GLOB
    SOURCES
      src/boosting/*.cpp
      src/io/*.cpp
      src/metric/*.cpp
      src/objective/*.cpp
      src/network/*.cpp
      src/treelearner/*.cpp
412
if(USE_CUDA OR USE_CUDA_EXP)
413
      src/treelearner/*.cu
414
endif()
415
if(USE_CUDA_EXP)
416
417
      src/boosting/cuda/*.cpp
      src/boosting/cuda/*.cu
418
419
      src/objective/cuda/*.cpp
      src/objective/cuda/*.cu
420
421
422
423
424
425
426
      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
427
428
)

429
430
431
432
add_library(lightgbm_objs OBJECT ${SOURCES})

add_executable(lightgbm src/main.cpp src/application/application.cpp)
target_link_libraries(lightgbm PRIVATE lightgbm_objs)
433

434
set(API_SOURCES "src/c_api.cpp")
435
436
# Only build the R part of the library if building for
# use with the R package
437
if(__BUILD_FOR_R)
438
  list(APPEND API_SOURCES "src/lightgbm_R.cpp")
439
endif()
440

441
442
add_library(lightgbm_capi_objs OBJECT ${API_SOURCES})

443
if(BUILD_STATIC_LIB)
444
  add_library(_lightgbm STATIC)
445
else()
446
  add_library(_lightgbm SHARED)
447
endif()
448
# LightGBM headers include openmp, cuda, R etc. headers,
449
450
# thus PUBLIC is required for building _lightgbm_swig target.
target_link_libraries(_lightgbm PUBLIC lightgbm_capi_objs lightgbm_objs)
451

452
if(MSVC)
453
  set_target_properties(_lightgbm PROPERTIES OUTPUT_NAME "lib_lightgbm")
454
endif()
455

456
457
if(USE_SWIG)
  set_property(SOURCE swig/lightgbmlib.i PROPERTY CPLUSPLUS ON)
458
  list(APPEND swig_options -package com.microsoft.ml.lightgbm)
459
460
461
  set_property(SOURCE swig/lightgbmlib.i PROPERTY SWIG_FLAGS "${swig_options}")
  swig_add_module(_lightgbm_swig java swig/lightgbmlib.i)
  swig_link_libraries(_lightgbm_swig _lightgbm)
462
  # needed to ensure Linux build does not have lib prefix specified twice, e.g. liblib_lightgbm_swig
463
  set_target_properties(_lightgbm_swig PROPERTIES PREFIX "")
464
  # needed in some versions of CMake for VS and MinGW builds to ensure output dll has lib prefix
465
466
467
  set_target_properties(_lightgbm_swig PROPERTIES OUTPUT_NAME "lib_lightgbm_swig")
  if(WIN32)
    if(MINGW OR CYGWIN)
468
469
470
        add_custom_command(
            TARGET _lightgbm_swig
            POST_BUILD
471
            COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
472
473
474
475
476
477
478
479
480
481
482
483
484
485
            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
        )
486
    else()
487
488
489
        add_custom_command(
            TARGET _lightgbm_swig
            POST_BUILD
490
491
            COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
            COMMAND cp "${PROJECT_SOURCE_DIR}/Release/*.dll" com/microsoft/ml/lightgbm/windows/x86_64
492
493
            COMMAND "${Java_JAR_EXECUTABLE}" -cf lightgbmlib.jar com
        )
494
    endif()
495
  elseif(APPLE)
496
497
498
499
500
501
502
503
504
505
506
    add_custom_command(
        TARGET _lightgbm_swig
        POST_BUILD
        COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
        COMMAND cp "${PROJECT_SOURCE_DIR}/*.dylib" com/microsoft/ml/lightgbm/osx/x86_64
        COMMAND
          cp
          "${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
    )
507
  else()
508
509
510
511
512
513
514
    add_custom_command(
        TARGET _lightgbm_swig
        POST_BUILD
        COMMAND "${Java_JAVAC_EXECUTABLE}" -d . java/*.java
        COMMAND cp "${PROJECT_SOURCE_DIR}/*.so" com/microsoft/ml/lightgbm/linux/x86_64
        COMMAND "${Java_JAR_EXECUTABLE}" -cf lightgbmlib.jar com
    )
515
  endif()
516
endif()
Guolin Ke's avatar
Guolin Ke committed
517
518

if(USE_MPI)
519
  target_link_libraries(lightgbm_objs PUBLIC ${MPI_CXX_LIBRARIES})
520
endif()
Guolin Ke's avatar
Guolin Ke committed
521

fanliwen's avatar
fanliwen committed
522
if(USE_OPENMP)
523
524
525
526
527
528
529
530
531
532
  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()
533
endif()
fanliwen's avatar
fanliwen committed
534

535
if(USE_GPU)
536
  target_link_libraries(lightgbm_objs PUBLIC ${OpenCL_LIBRARY} ${Boost_LIBRARIES})
537
endif()
538

539
if(__INTEGRATE_OPENCL)
540
  # targets OpenCL and Boost are added in IntegratedOpenCL.cmake
541
  add_dependencies(lightgbm_objs OpenCL Boost)
542
  # variables INTEGRATED_OPENCL_* are set in IntegratedOpenCL.cmake
543
544
545
  target_include_directories(lightgbm_objs PRIVATE ${INTEGRATED_OPENCL_INCLUDES})
  target_compile_definitions(lightgbm_objs PRIVATE ${INTEGRATED_OPENCL_DEFINITIONS})
  target_link_libraries(lightgbm_objs PUBLIC ${INTEGRATED_OPENCL_LIBRARIES})
546
547
endif()

548
if(USE_CUDA OR USE_CUDA_EXP)
549
550
551
552
553
  # 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)
554
  set_target_properties(lightgbm PROPERTIES CUDA_ARCHITECTURES OFF)
555

556
557
  set_target_properties(lightgbm_objs PROPERTIES CUDA_SEPARABLE_COMPILATION ON)

558
559
560
  # Device linking is not supported for object libraries.
  # Thus we have to specify them on final targets.
  set_target_properties(lightgbm PROPERTIES CUDA_RESOLVE_DEVICE_SYMBOLS ON)
561
  set_target_properties(_lightgbm PROPERTIES CUDA_RESOLVE_DEVICE_SYMBOLS ON)
562
563
564
565
566
567

  # 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.
  target_link_libraries(lightgbm PRIVATE ${histograms})
  target_link_libraries(_lightgbm PRIVATE ${histograms})
568
endif()
569

570
if(USE_HDFS)
571
  target_link_libraries(lightgbm_objs PUBLIC ${HDFS_CXX_LIBRARIES})
572
endif()
573

574
575
if(WIN32)
    if(MINGW OR CYGWIN)
576
      target_link_libraries(lightgbm_objs PUBLIC Ws2_32 IPHLPAPI)
577
578
    endif()
endif()
Guolin Ke's avatar
Guolin Ke committed
579

580
if(__BUILD_FOR_R)
581
582
  # utils/log.h and capi uses R headers, thus both object libraries need to link
  # with R lib.
583
  if(MSVC)
584
    set(R_LIB ${LIBR_MSVC_CORE_LIBRARY})
585
  else()
586
    set(R_LIB ${LIBR_CORE_LIBRARY})
587
  endif()
588
589
  target_link_libraries(lightgbm_objs PUBLIC ${R_LIB})
  target_link_libraries(lightgbm_capi_objs PUBLIC ${R_LIB})
590
endif()
591

592
593
594
595
596
597
598
599
600
#-- 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
601
      GIT_TAG        release-1.11.0
602
603
604
605
    )
    FetchContent_MakeAvailable(googletest)
    add_library(GTest::GTest ALIAS gtest)
  endif()
606
607
608
609

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

610
611
612
613
614
615
616
617
618
619
620
621
622
623
  file(GLOB CPP_TEST_SOURCES tests/cpp_tests/*.cpp)
  if(MSVC)
    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()
624
  endif()
625
  add_executable(testlightgbm ${CPP_TEST_SOURCES})
626
  target_link_libraries(testlightgbm PRIVATE lightgbm_objs lightgbm_capi_objs GTest::GTest)
627
628
endif()

629
630
631
632
633
634
install(
  TARGETS lightgbm _lightgbm
  RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
  LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
  ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
)
635

636
install(DIRECTORY ${LightGBM_HEADER_DIR}/LightGBM DESTINATION ${CMAKE_INSTALL_PREFIX}/include)