CMakeLists.txt 25.3 KB
Newer Older
1
2
3
4
5
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_TIMETAG "Set to ON to output time costs" OFF)
6
option(USE_CUDA "Enable CUDA-accelerated training " OFF)
7
8
9
option(USE_DEBUG "Set to ON for Debug mode" OFF)
option(USE_SANITIZER "Use santizer flags" OFF)
set(
10
11
12
13
14
15
16
  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."
)
17
option(BUILD_CLI "Build the 'lightbgm' command-line interface in addition to lib_lightgbm" ON)
18
19
option(BUILD_CPP_TEST "Build C++ tests with Google Test" OFF)
option(BUILD_STATIC_LIB "Build static library" OFF)
20
21
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)
22
23
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)
24

25
cmake_minimum_required(VERSION 3.18)
Guolin Ke's avatar
Guolin Ke committed
26

27
28
29
30
31
32
33
34
# If using Visual Studio generators, always target v10.x of the Windows SDK.
# Doing this avoids lookups that could fall back to very old versions, e.g. by finding
# outdated registry entries.
# ref: https://cmake.org/cmake/help/latest/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.html
if(CMAKE_GENERATOR MATCHES "Visual Studio")
    set(CMAKE_SYSTEM_VERSION 10.0 CACHE INTERNAL "target Windows SDK version" FORCE)
endif()

35
project(lightgbm LANGUAGES C CXX)
Guolin Ke's avatar
Guolin Ke committed
36

37
38
39
40
41
42
43
if(BUILD_CPP_TEST)
  set(CMAKE_CXX_STANDARD 14)
else()
  set(CMAKE_CXX_STANDARD 11)
endif()
set(CMAKE_CXX_STANDARD_REQUIRED ON)

44
45
46
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules")

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

55
56
57
58
59
60
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()

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

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

117
set(EIGEN_DIR "${PROJECT_SOURCE_DIR}/external_libs/eigen")
118
119
include_directories(${EIGEN_DIR})

120
# See https://gitlab.com/libeigen/eigen/-/blob/master/COPYING.README
121
add_definitions(-DEIGEN_MPL2_ONLY)
122
add_definitions(-DEIGEN_DONT_PARALLELIZE)
123

124
125
126
127
128
129
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})

130
if(__BUILD_FOR_R)
131
132
133
134
135
    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})
136
    add_definitions(-DLGB_R_BUILD)
137
endif()
138

139
if(USE_TIMETAG)
140
    add_definitions(-DTIMETAG)
141
endif()
142

Guolin Ke's avatar
Guolin Ke committed
143
if(USE_DEBUG)
144
    add_definitions(-DDEBUG)
145
endif()
Guolin Ke's avatar
Guolin Ke committed
146

Guolin Ke's avatar
Guolin Ke committed
147
if(USE_MPI)
Guolin Ke's avatar
Guolin Ke committed
148
    find_package(MPI REQUIRED)
149
    add_definitions(-DUSE_MPI)
Guolin Ke's avatar
Guolin Ke committed
150
else()
151
    add_definitions(-DUSE_SOCKET)
152
endif()
Guolin Ke's avatar
Guolin Ke committed
153

154
if(USE_CUDA)
155
    set(CMAKE_CUDA_HOST_COMPILER "${CMAKE_CXX_COMPILER}")
156
    enable_language(CUDA)
157
    set(USE_OPENMP ON CACHE BOOL "CUDA requires OpenMP" FORCE)
158
endif()
159

160
if(USE_OPENMP)
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    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()
179
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
180
endif()
Guolin Ke's avatar
Guolin Ke committed
181

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

200
if(__INTEGRATE_OPENCL)
201
202
203
    if(APPLE)
        message(FATAL_ERROR "Integrated OpenCL build is not available on macOS")
    else()
204
        include(cmake/IntegratedOpenCL.cmake)
205
        add_definitions(-DUSE_GPU)
206
207
    endif()
endif()
208

209
210
211
212
213
if(BUILD_CPP_TEST AND MSVC)
  # Use /MT flag to statically link the C runtime
  set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
endif()

214
if(USE_CUDA)
215
216
    find_package(CUDAToolkit 11.0 REQUIRED)
    include_directories(${CUDAToolkit_INCLUDE_DIRS})
217
    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -Xcompiler=${OpenMP_CXX_FLAGS} -Xcompiler=-fPIC -Xcompiler=-Wall")
218

219
220
    # reference for mapping of CUDA toolkit component versions to supported architectures ("compute capabilities"):
    # https://en.wikipedia.org/wiki/CUDA#GPUs_supported
221
222
223
    set(CUDA_ARCHS "60" "61" "62" "70" "75")
    if(CUDA_VERSION VERSION_GREATER_EQUAL "110")
        list(APPEND CUDA_ARCHS "80")
224
    endif()
225
226
    if(CUDA_VERSION VERSION_GREATER_EQUAL "111")
        list(APPEND CUDA_ARCHS "86")
227
    endif()
228
229
    if(CUDA_VERSION VERSION_GREATER_EQUAL "115")
        list(APPEND CUDA_ARCHS "87")
230
    endif()
231
232
233
    if(CUDA_VERSION VERSION_GREATER_EQUAL "118")
        list(APPEND CUDA_ARCHS "89")
        list(APPEND CUDA_ARCHS "90")
234
    endif()
235
236
    list(POP_BACK CUDA_ARCHS CUDA_LAST_SUPPORTED_ARCH)
    list(APPEND CUDA_ARCHS "${CUDA_LAST_SUPPORTED_ARCH}+PTX")
237
    if(USE_DEBUG)
238
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -g")
239
    else()
240
      set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -O3 -lineinfo")
241
242
243
    endif()
    message(STATUS "CMAKE_CUDA_FLAGS: ${CMAKE_CUDA_FLAGS}")

244
    add_definitions(-DUSE_CUDA)
245

246
    if(NOT DEFINED CMAKE_CUDA_STANDARD)
247
248
249
250
      set(CMAKE_CUDA_STANDARD 11)
      set(CMAKE_CUDA_STANDARD_REQUIRED ON)
    endif()

251
252
253
254
    set(
      BASE_DEFINES
      -DPOWER_FEATURE_WORKGROUPS=12
      -DUSE_CONSTANT_BUF=0
255
    )
256
257
258
259
    set(
      ALLFEATS_DEFINES
      ${BASE_DEFINES}
      -DENABLE_ALL_FEATURES
260
    )
261
262
263
264
    set(
      FULLDATA_DEFINES
      ${ALLFEATS_DEFINES}
      -DIGNORE_INDICES
265
266
267
268
269
270
271
272
    )

    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)
273
      set_target_properties(histo${hsize}${hname} PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
274
275
276
277
278
      if(hadd)
        list(APPEND histograms histo${hsize}${hname})
        set(histograms ${histograms} PARENT_SCOPE)
      endif()
      target_compile_definitions(
279
280
        histo${hsize}${hname}
        PRIVATE
281
282
283
284
285
        -DCONST_HESSIAN=${hconst}
        ${hdir}
      )
    endfunction()

286
    foreach(hsize _16_64_256)
287
288
289
290
291
292
293
      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()
294
endif()
295

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

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

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

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

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

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

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

409
include_directories(${LightGBM_HEADER_DIR})
Guolin Ke's avatar
Guolin Ke committed
410
411
412

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

415
416
417
418
419
420
421
422
423
file(
    GLOB
    SOURCES
      src/boosting/*.cpp
      src/io/*.cpp
      src/metric/*.cpp
      src/objective/*.cpp
      src/network/*.cpp
      src/treelearner/*.cpp
424
      src/utils/*.cpp
425
426
427
428
)
file(
    GLOB
    LGBM_CUDA_SOURCES
429
      src/treelearner/*.cu
430
431
      src/boosting/cuda/*.cpp
      src/boosting/cuda/*.cu
432
433
      src/metric/cuda/*.cpp
      src/metric/cuda/*.cu
434
435
      src/objective/cuda/*.cpp
      src/objective/cuda/*.cu
436
437
438
439
440
441
      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
442
443
)

444
445
446
447
if(USE_CUDA)
  list(APPEND SOURCES ${LGBM_CUDA_SOURCES})
endif()

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
470
471
472
473
474
475
476
477
478
479

# 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()

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

484
if(MSVC AND NOT __BUILD_FOR_R)
485
  set_target_properties(_lightgbm PROPERTIES OUTPUT_NAME "lib_lightgbm")
486
endif()
487

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

if(USE_MPI)
580
  target_link_libraries(lightgbm_objs PUBLIC ${MPI_CXX_LIBRARIES})
581
endif()
Guolin Ke's avatar
Guolin Ke committed
582

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

596
if(USE_GPU)
597
  target_link_libraries(lightgbm_objs PUBLIC ${OpenCL_LIBRARY} ${Boost_LIBRARIES})
598
endif()
599

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

609
if(USE_CUDA)
610
611
  set_target_properties(lightgbm_objs PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
  set_target_properties(_lightgbm PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
612
  if(BUILD_CLI)
613
    set_target_properties(lightgbm PROPERTIES CUDA_ARCHITECTURES ${CUDA_ARCHS})
614
  endif()
615

616
617
  set_target_properties(lightgbm_objs PROPERTIES CUDA_SEPARABLE_COMPILATION ON)

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

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

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

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

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

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

670
671
  file(GLOB CPP_TEST_SOURCES tests/cpp_tests/*.cpp)
  if(MSVC)
June Liu's avatar
June Liu committed
672
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /permissive-")
673
  endif()
674
  add_executable(testlightgbm ${CPP_TEST_SOURCES})
675
  target_link_libraries(testlightgbm PRIVATE lightgbm_objs lightgbm_capi_objs GTest::GTest)
676
677
endif()

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

685
686
687
688
if(__BUILD_FOR_PYTHON)
    set(CMAKE_INSTALL_PREFIX "lightgbm")
endif()

689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
# The macOS linker puts an absolute path to linked libraries in lib_lightgb.dylib.
# This block overrides that information for LightGBM's OpenMP dependency, to allow
# finding that library in more places.
#
# This reduces the risk of runtime issues resulting from multiple libomp.dylib being loaded.
#
if(APPLE AND USE_OPENMP)
  # store path to libomp found at build time in a variable
  get_target_property(
    OpenMP_LIBRARY_LOCATION
    OpenMP::OpenMP_CXX
    INTERFACE_LINK_LIBRARIES
  )
  # get just the filename of that path
  # (to deal with the possibility that it might be 'libomp.dylib' or 'libgomp.dylib' or 'libiomp.dylib')
  get_filename_component(
    OpenMP_LIBRARY_NAME
    ${OpenMP_LIBRARY_LOCATION}
    NAME
  )
  # get directory of that path
  get_filename_component(
    OpenMP_LIBRARY_DIR
    ${OpenMP_LIBRARY_LOCATION}
    DIRECTORY
  )
  # get exact name of the library in a variable
  get_target_property(
    __LIB_LIGHTGBM_OUTPUT_NAME
    _lightgbm
    OUTPUT_NAME
  )
  if(NOT __LIB_LIGHTGBM_OUTPUT_NAME)
    set(__LIB_LIGHTGBM_OUTPUT_NAME "lib_lightgbm")
  endif()

  if(CMAKE_SHARED_LIBRARY_SUFFIX_CXX)
    set(
      __LIB_LIGHTGBM_FILENAME "${__LIB_LIGHTGBM_OUTPUT_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX_CXX}"
      CACHE INTERNAL "lightgbm shared library filename"
    )
  else()
    set(
      __LIB_LIGHTGBM_FILENAME "${__LIB_LIGHTGBM_OUTPUT_NAME}.dylib"
      CACHE INTERNAL "lightgbm shared library filename"
    )
  endif()

  # Override the absolute path to OpenMP with a relative one using @rpath.
  #
  # This also ensures that if a libomp.dylib has already been loaded, it'll just use that.
  add_custom_command(
    TARGET _lightgbm
    POST_BUILD
      COMMAND
        install_name_tool
        -change
        ${OpenMP_LIBRARY_LOCATION}
        "@rpath/${OpenMP_LIBRARY_NAME}"
        "${__LIB_LIGHTGBM_FILENAME}"
      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
      COMMENT "Replacing hard-coded OpenMP install_name with '@rpath/${OpenMP_LIBRARY_NAME}'..."
  )
  # add RPATH entries to ensure the loader looks in the following, in the following order:
  #
  #   - /opt/homebrew/opt/libomp/lib (where 'brew install' / 'brew link' puts libomp.dylib)
  #   - ${OpenMP_LIBRARY_DIR}        (wherever find_package(OpenMP) found OpenMP at build time)
  #
  set_target_properties(
    _lightgbm
    PROPERTIES
      BUILD_WITH_INSTALL_RPATH TRUE
      INSTALL_RPATH "/opt/homebrew/opt/libomp/lib;${OpenMP_LIBRARY_DIR}"
      INSTALL_RPATH_USE_LINK_PATH FALSE
  )
endif()

766
install(
767
  TARGETS _lightgbm
768
769
770
771
  RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin
  LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
  ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
)
772

773
if(INSTALL_HEADERS)
774
775
776
777
778
779
780
781
782
783
784
785
786
    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"
    )
787
endif()