CMakeLists.txt 23 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
cmake_minimum_required(VERSION 3.18)
Guolin Ke's avatar
Guolin Ke committed
27

28
project(lightgbm LANGUAGES C CXX)
Guolin Ke's avatar
Guolin Ke committed
29

30
31
32
33
34
35
36
if(BUILD_CPP_TEST)
  set(CMAKE_CXX_STANDARD 14)
else()
  set(CMAKE_CXX_STANDARD 11)
endif()
set(CMAKE_CXX_STANDARD_REQUIRED ON)

37
38
39
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules")

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

48
49
50
51
52
53
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()

54
55
56
57
58
59
60
61
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
62
63
64
65
66
67
68
69
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()
70
71
72
73
74
75
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)
76
77
78
79
    message(
      FATAL_ERROR
      "The compiler ${CMAKE_CXX_COMPILER} doesn't support required C++11 features. Please use a newer MSVC."
    )
80
  endif()
81
endif()
Guolin Ke's avatar
Guolin Ke committed
82

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

110
set(EIGEN_DIR "${PROJECT_SOURCE_DIR}/external_libs/eigen")
111
112
include_directories(${EIGEN_DIR})

113
# See https://gitlab.com/libeigen/eigen/-/blob/master/COPYING.README
114
add_definitions(-DEIGEN_MPL2_ONLY)
115
add_definitions(-DEIGEN_DONT_PARALLELIZE)
116

117
118
119
120
121
122
set(FAST_DOUBLE_PARSER_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/external_libs/fast_double_parser/include")
include_directories(${FAST_DOUBLE_PARSER_INCLUDE_DIR})

set(FMT_INCLUDE_DIR "${PROJECT_SOURCE_DIR}/external_libs/fmt/include")
include_directories(${FMT_INCLUDE_DIR})

123
if(__BUILD_FOR_R)
124
125
126
127
128
    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})
129
    add_definitions(-DLGB_R_BUILD)
130
endif()
131

132
if(USE_TIMETAG)
133
    add_definitions(-DTIMETAG)
134
endif()
135

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

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

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

153
if(USE_OPENMP)
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
    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()
172
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
173
endif()
Guolin Ke's avatar
Guolin Ke committed
174

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

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

202
if(USE_CUDA)
203
204
    find_package(CUDAToolkit 11.0 REQUIRED)
    include_directories(${CUDAToolkit_INCLUDE_DIRS})
205
    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -Xcompiler=${OpenMP_CXX_FLAGS} -Xcompiler=-fPIC -Xcompiler=-Wall")
206

207
208
    # reference for mapping of CUDA toolkit component versions to supported architectures ("compute capabilities"):
    # https://en.wikipedia.org/wiki/CUDA#GPUs_supported
209
210
211
    set(CUDA_ARCHS "60" "61" "62" "70" "75")
    if(CUDA_VERSION VERSION_GREATER_EQUAL "110")
        list(APPEND CUDA_ARCHS "80")
212
    endif()
213
214
    if(CUDA_VERSION VERSION_GREATER_EQUAL "111")
        list(APPEND CUDA_ARCHS "86")
215
    endif()
216
217
    if(CUDA_VERSION VERSION_GREATER_EQUAL "115")
        list(APPEND CUDA_ARCHS "87")
218
    endif()
219
220
221
    if(CUDA_VERSION VERSION_GREATER_EQUAL "118")
        list(APPEND CUDA_ARCHS "89")
        list(APPEND CUDA_ARCHS "90")
222
    endif()
223
224
    list(POP_BACK CUDA_ARCHS CUDA_LAST_SUPPORTED_ARCH)
    list(APPEND CUDA_ARCHS "${CUDA_LAST_SUPPORTED_ARCH}+PTX")
225
    if(USE_DEBUG)
226
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -g")
227
    else()
228
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -O3 -lineinfo")
229
230
231
    endif()
    message(STATUS "CMAKE_CUDA_FLAGS: ${CMAKE_CUDA_FLAGS}")

232
    add_definitions(-DUSE_CUDA)
233

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

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

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

274
    foreach(hsize _16_64_256)
275
276
277
278
279
280
281
      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()
282
endif()
283

284
if(USE_HDFS)
James Lamb's avatar
James Lamb committed
285
286
287
288
289
290
    message(
      DEPRECATION
      "HDFS support in LightGBM is deprecated, and will be removed in a future release.\
      See https://github.com/microsoft/LightGBM/issues/6436.
      "
    )
291
292
293
294
    find_package(JNI REQUIRED)
    find_path(HDFS_INCLUDE_DIR hdfs.h REQUIRED)
    find_library(HDFS_LIB NAMES hdfs REQUIRED)
    include_directories(${HDFS_INCLUDE_DIR})
295
296
    add_definitions(-DUSE_HDFS)
    set(HDFS_CXX_LIBRARIES ${HDFS_LIB} ${JAVA_JVM_LIBRARY})
297
endif()
298

299
300
301
302
303
304
305
306
307
308
309
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})
310
  message(STATUS "Using _mm_prefetch")
311
  add_definitions(-DMM_PREFETCH)
312
313
endif()

314
315
316
317
318
319
320
321
322
323
324
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})
325
  message(STATUS "Using _mm_malloc")
326
  add_definitions(-DMM_MALLOC)
327
328
endif()

Guolin Ke's avatar
Guolin Ke committed
329
if(UNIX OR MINGW OR CYGWIN)
330
  set(
331
    CMAKE_CXX_FLAGS
332
    "${CMAKE_CXX_FLAGS} -pthread -Wextra -Wall -Wno-ignored-attributes -Wno-unknown-pragmas -Wno-return-type"
333
  )
334
335
336
337
338
339
340
  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()
341
  if(USE_DEBUG)
342
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -O0")
343
  else()
344
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
345
346
  endif()
  if(USE_SWIG)
347
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-strict-aliasing")
348
349
  endif()
  if(NOT USE_OPENMP)
350
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unknown-pragmas -Wno-unused-private-field")
351
352
  endif()
  if(__BUILD_FOR_R AND CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
353
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-cast-function-type")
354
  endif()
Guolin Ke's avatar
Guolin Ke committed
355
356
endif()

Nikita Titov's avatar
Nikita Titov committed
357
if(WIN32 AND MINGW)
358
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -static-libstdc++")
Nikita Titov's avatar
Nikita Titov committed
359
360
endif()

361
362
363
364
365
366
367
368
369
370
371
372
# 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
373
if(MSVC)
374
    set(
375
      variables
Guolin Ke's avatar
Guolin Ke committed
376
377
378
379
380
381
382
383
384
        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
    )
385
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4 /MP")
386
387
388
389
390
391
392
    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
393
    if(USE_DEBUG)
394
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Od")
Guolin Ke's avatar
Guolin Ke committed
395
    else()
396
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /O2 /Ob2 /Oi /Ot /Oy")
Guolin Ke's avatar
Guolin Ke committed
397
    endif()
Guolin Ke's avatar
Guolin Ke committed
398
else()
399
400
401
    if(NOT BUILD_STATIC_LIB)
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
    endif()
Guolin Ke's avatar
Guolin Ke committed
402
    if(NOT USE_DEBUG)
403
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -funroll-loops")
Guolin Ke's avatar
Guolin Ke committed
404
    endif()
405
endif()
Guolin Ke's avatar
Guolin Ke committed
406

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

409
410
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
Guolin Ke's avatar
Guolin Ke committed
411

412
include_directories(${LightGBM_HEADER_DIR})
Guolin Ke's avatar
Guolin Ke committed
413
414
415

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

418
419
420
421
422
423
424
425
426
file(
    GLOB
    SOURCES
      src/boosting/*.cpp
      src/io/*.cpp
      src/metric/*.cpp
      src/objective/*.cpp
      src/network/*.cpp
      src/treelearner/*.cpp
427
      src/utils/*.cpp
428
429
430
431
)
file(
    GLOB
    LGBM_CUDA_SOURCES
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
      src/treelearner/cuda/*.cpp
      src/treelearner/cuda/*.cu
      src/io/cuda/*.cu
      src/io/cuda/*.cpp
      src/cuda/*.cpp
      src/cuda/*.cu
Guolin Ke's avatar
Guolin Ke committed
445
446
)

447
448
449
450
if(USE_CUDA)
  list(APPEND SOURCES ${LGBM_CUDA_SOURCES})
endif()

451
452
add_library(lightgbm_objs OBJECT ${SOURCES})

453
454
455
456
if(BUILD_CLI)
    add_executable(lightgbm src/main.cpp src/application/application.cpp)
    target_link_libraries(lightgbm PRIVATE lightgbm_objs)
endif()
457

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

465
466
add_library(lightgbm_capi_objs OBJECT ${API_SOURCES})

467
if(BUILD_STATIC_LIB)
468
  add_library(_lightgbm STATIC)
469
else()
470
  add_library(_lightgbm SHARED)
471
endif()
472
473
474
475
476
477
478
479
480
481
482

# R expects libraries of the form <project>.{dll,dylib,so}, not lib_<project>.{dll,dylib,so}
if(__BUILD_FOR_R)
  set_target_properties(
    _lightgbm
    PROPERTIES
      PREFIX ""
      OUTPUT_NAME "lightgbm"
  )
endif()

483
# LightGBM headers include openmp, cuda, R etc. headers,
484
485
# thus PUBLIC is required for building _lightgbm_swig target.
target_link_libraries(_lightgbm PUBLIC lightgbm_capi_objs lightgbm_objs)
486

487
if(MSVC AND NOT __BUILD_FOR_R)
488
  set_target_properties(_lightgbm PROPERTIES OUTPUT_NAME "lib_lightgbm")
489
endif()
490

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

if(USE_MPI)
577
  target_link_libraries(lightgbm_objs PUBLIC ${MPI_CXX_LIBRARIES})
578
endif()
Guolin Ke's avatar
Guolin Ke committed
579

fanliwen's avatar
fanliwen committed
580
if(USE_OPENMP)
581
582
583
584
585
586
587
588
589
590
  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()
591
endif()
fanliwen's avatar
fanliwen committed
592

593
if(USE_GPU)
594
  target_link_libraries(lightgbm_objs PUBLIC ${OpenCL_LIBRARY} ${Boost_LIBRARIES})
595
endif()
596

597
if(__INTEGRATE_OPENCL)
598
  # targets OpenCL and Boost are added in IntegratedOpenCL.cmake
599
  add_dependencies(lightgbm_objs OpenCL Boost)
600
  # variables INTEGRATED_OPENCL_* are set in IntegratedOpenCL.cmake
601
602
  target_include_directories(lightgbm_objs PRIVATE ${INTEGRATED_OPENCL_INCLUDES})
  target_compile_definitions(lightgbm_objs PRIVATE ${INTEGRATED_OPENCL_DEFINITIONS})
603
  target_link_libraries(lightgbm_objs PUBLIC ${INTEGRATED_OPENCL_LIBRARIES} ${CMAKE_DL_LIBS})
604
605
endif()

606
if(USE_CUDA)
607
608
  set_target_properties(lightgbm_objs PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
  set_target_properties(_lightgbm PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
609
  if(BUILD_CLI)
610
    set_target_properties(lightgbm PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
611
  endif()
612

613
614
  set_target_properties(lightgbm_objs PROPERTIES CUDA_SEPARABLE_COMPILATION ON)

615
616
  # Device linking is not supported for object libraries.
  # Thus we have to specify them on final targets.
617
618
619
  if(BUILD_CLI)
    set_target_properties(lightgbm PROPERTIES CUDA_RESOLVE_DEVICE_SYMBOLS ON)
  endif()
620
  set_target_properties(_lightgbm PROPERTIES CUDA_RESOLVE_DEVICE_SYMBOLS ON)
621
622
623
624

  # 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.
625
626
627
  if(BUILD_CLI)
    target_link_libraries(lightgbm PRIVATE ${histograms})
  endif()
628
  target_link_libraries(_lightgbm PRIVATE ${histograms})
629
endif()
630

631
if(USE_HDFS)
632
  target_link_libraries(lightgbm_objs PUBLIC ${HDFS_CXX_LIBRARIES})
633
endif()
634

635
636
if(WIN32)
    if(MINGW OR CYGWIN)
637
      target_link_libraries(lightgbm_objs PUBLIC ws2_32 iphlpapi)
638
639
    endif()
endif()
Guolin Ke's avatar
Guolin Ke committed
640

641
if(__BUILD_FOR_R)
642
643
  # utils/log.h and capi uses R headers, thus both object libraries need to link
  # with R lib.
644
  if(MSVC)
645
    set(R_LIB ${LIBR_MSVC_CORE_LIBRARY})
646
  else()
647
    set(R_LIB ${LIBR_CORE_LIBRARY})
648
  endif()
649
650
  target_link_libraries(lightgbm_objs PUBLIC ${R_LIB})
  target_link_libraries(lightgbm_capi_objs PUBLIC ${R_LIB})
651
endif()
652

653
654
655
656
657
658
659
660
661
#-- 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
662
      GIT_TAG        v1.14.0
663
664
665
666
    )
    FetchContent_MakeAvailable(googletest)
    add_library(GTest::GTest ALIAS gtest)
  endif()
667
668
669
670

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

671
672
  file(GLOB CPP_TEST_SOURCES tests/cpp_tests/*.cpp)
  if(MSVC)
June Liu's avatar
June Liu committed
673
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /permissive-")
674
675
676
677
678
679
680
681
682
683
684
685
    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()
686
  endif()
687
  add_executable(testlightgbm ${CPP_TEST_SOURCES})
688
  target_link_libraries(testlightgbm PRIVATE lightgbm_objs lightgbm_capi_objs GTest::GTest)
689
690
endif()

691
692
693
694
695
696
697
if(BUILD_CLI)
    install(
      TARGETS lightgbm
      RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
    )
endif()

698
699
700
701
if(__BUILD_FOR_PYTHON)
    set(CMAKE_INSTALL_PREFIX "lightgbm")
endif()

702
install(
703
  TARGETS _lightgbm
704
705
706
707
  RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
  LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
  ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
)
708

709
if(INSTALL_HEADERS)
710
711
712
713
714
715
716
717
718
719
720
721
722
    install(
      DIRECTORY ${LightGBM_HEADER_DIR}/LightGBM
      DESTINATION ${CMAKE_INSTALL_PREFIX}/include
    )
    install(
      FILES ${FAST_DOUBLE_PARSER_INCLUDE_DIR}/fast_double_parser.h
      DESTINATION ${CMAKE_INSTALL_PREFIX}/include/LightGBM/utils
    )
    install(
      DIRECTORY ${FMT_INCLUDE_DIR}/
      DESTINATION ${CMAKE_INSTALL_PREFIX}/include/LightGBM/utils
      FILES_MATCHING PATTERN "*.h"
    )
723
endif()