generic.cmake 13.8 KB
Newer Older
L
liaogang 已提交
1
# Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.
2
#
L
liaogang 已提交
3 4 5
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
6
#
L
liaogang 已提交
7
# http://www.apache.org/licenses/LICENSE-2.0
8
#
L
liaogang 已提交
9 10 11 12 13
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
14
#
15 16


Y
Yi Wang 已提交
17 18 19
# generic.cmake defines CMakes functions that look like Bazel's
# building rules (https://bazel.build/).
#
W
wuyi05 已提交
20
#
L
liaogang 已提交
21
# -------------------------------------------
22
#     C++        CUDA C++       Go
L
liaogang 已提交
23
# -------------------------------------------
24 25 26
# cc_library    nv_library   go_library
# cc_binary     nv_binary    go_binary
# cc_test       nv_test      go_test
L
liaogang 已提交
27
# -------------------------------------------
W
wuyi05 已提交
28
#
Y
Yi Wang 已提交
29 30
# To build a static library example.a from example.cc using the system
#  compiler (like GCC):
W
wuyi05 已提交
31
#
32
#   cc_library(example SRCS example.cc)
W
wuyi05 已提交
33
#
Y
Yi Wang 已提交
34 35
# To build a static library example.a from multiple source files
# example{1,2,3}.cc:
W
wuyi05 已提交
36
#
37
#   cc_library(example SRCS example1.cc example2.cc example3.cc)
W
wuyi05 已提交
38
#
39
# To build a shared library example.so from example.cc:
W
wuyi05 已提交
40
#
41
#   cc_library(example SHARED SRCS example.cc)
W
wuyi05 已提交
42
#
Y
Yi Wang 已提交
43 44
# To build a library using Nvidia's NVCC from .cu file(s), use the nv_
# prefixed version:
W
wuyi05 已提交
45
#
46
#   nv_library(example SRCS example.cu)
W
wuyi05 已提交
47
#
48
# To specify that a library new_example.a depends on other libraies:
W
wuyi05 已提交
49
#
50
#   cc_library(new_example SRCS new_example.cc DEPS example)
W
wuyi05 已提交
51
#
52
# Static libraries can be composed of other static libraries:
W
wuyi05 已提交
53
#
54
#   cc_library(composed DEPS dependent1 dependent2 dependent3)
W
wuyi05 已提交
55
#
Y
Yi Wang 已提交
56 57
# To build an executable binary file from some source files and
# dependent libraries:
W
wuyi05 已提交
58
#
59
#   cc_binary(example SRCS main.cc something.cc DEPS example1 example2)
W
wuyi05 已提交
60
#
Y
Yi Wang 已提交
61 62
# To build an executable binary file using NVCC, use the nv_ prefixed
# version:
W
wuyi05 已提交
63
#
64
#   nv_binary(example SRCS main.cc something.cu DEPS example1 example2)
W
wuyi05 已提交
65
#
Y
Yi Wang 已提交
66 67
# To build a unit test binary, which is an executable binary with
# GoogleTest linked:
W
wuyi05 已提交
68
#
69
#   cc_test(example_test SRCS example_test.cc DEPS example)
W
wuyi05 已提交
70
#
71
# To build a unit test binary using NVCC, use the nv_ prefixed version:
W
wuyi05 已提交
72
#
73
#   nv_test(example_test SRCS example_test.cu DEPS example)
74
#
Y
Yi Wang 已提交
75 76 77
# It is pretty often that executable and test binaries depend on
# pre-defined external libaries like glog and gflags defined in
# /cmake/external/*.cmake:
78
#
79
#   cc_test(example_test SRCS example_test.cc DEPS example glog gflags)
L
liaogang 已提交
80 81 82 83 84 85 86 87 88
#
# To build a go static library using Golang, use the go_ prefixed version:
#
#   go_library(example STATIC)
#
# To build a go shared library using Golang, use the go_ prefixed version:
#
#   go_library(example SHARED)
#
L
liaogang 已提交
89

Y
Yu Yang 已提交
90
# including binary directory for generated headers.
91
include_directories(${CMAKE_CURRENT_BINARY_DIR})
Y
Yu Yang 已提交
92

L
liaogang 已提交
93 94 95
if(NOT APPLE)
    find_package(Threads REQUIRED)
    link_libraries(${CMAKE_THREAD_LIBS_INIT})
G
gangliao 已提交
96
    set(CMAKE_CXX_LINK_EXECUTABLE "${CMAKE_CXX_LINK_EXECUTABLE} -ldl -lrt")
L
liaogang 已提交
97
endif(NOT APPLE)
98

99
function(merge_static_libs TARGET_NAME)
L
liaogang 已提交
100 101
  set(libs ${ARGN})
  list(REMOVE_DUPLICATES libs)
102

103
  # Get all propagation dependencies from the merged libraries
L
liaogang 已提交
104
  foreach(lib ${libs})
105
    list(APPEND libs_deps ${${lib}_LIB_DEPENDS})
106 107 108
  endforeach()

  if(APPLE) # Use OSX's libtool to merge archives
109
    # To produce a library we need at least one source file.
110
    # It is created by add_custom_command below and will helps
111
    # also help to track dependencies.
112
    set(dummyfile ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}_dummy.c)
113 114 115 116 117 118 119 120 121

    # Make the generated dummy source file depended on all static input
    # libs. If input lib changes,the source file is touched
    # which causes the desired effect (relink).
    add_custom_command(OUTPUT ${dummyfile}
      COMMAND ${CMAKE_COMMAND} -E touch ${dummyfile}
      DEPENDS ${libs})

    # Generate dummy staic lib
122 123
    file(WRITE ${dummyfile} "const char * dummy = \"${dummyfile}\";")
    add_library(${TARGET_NAME} STATIC ${dummyfile})
124 125 126 127 128 129
    target_link_libraries(${TARGET_NAME} ${libs_deps})

    foreach(lib ${libs})
      # Get the file names of the libraries to be merged
      set(libfiles ${libfiles} $<TARGET_FILE:${lib}>)
    endforeach()
130 131 132
		add_custom_command(TARGET ${TARGET_NAME} POST_BUILD
      COMMAND rm "${CMAKE_CURRENT_BINARY_DIR}/lib${TARGET_NAME}.a"
      COMMAND /usr/bin/libtool -static -o "${CMAKE_CURRENT_BINARY_DIR}/lib${TARGET_NAME}.a" ${libfiles})
133
  else() # general UNIX: use "ar" to extract objects and re-add to a common lib
L
liaogang 已提交
134 135 136
    foreach(lib ${libs})
      set(objlistfile ${lib}.objlist) # list of objects in the input library
      set(objdir ${lib}.objdir)
137

L
liaogang 已提交
138
      add_custom_command(OUTPUT ${objdir}
139 140
        COMMAND ${CMAKE_COMMAND} -E make_directory ${objdir}
        DEPENDS ${lib})
141

L
liaogang 已提交
142 143 144 145 146
      add_custom_command(OUTPUT ${objlistfile}
        COMMAND ${CMAKE_AR} -x "$<TARGET_FILE:${lib}>"
        COMMAND ${CMAKE_AR} -t "$<TARGET_FILE:${lib}>" > ../${objlistfile}
        DEPENDS ${lib} ${objdir}
        WORKING_DIRECTORY ${objdir})
147

148 149 150 151 152
      # Empty dummy source file that goes into merged library
      set(mergebase ${lib}.mergebase.c)
      add_custom_command(OUTPUT ${mergebase}
        COMMAND ${CMAKE_COMMAND} -E touch ${mergebase}
        DEPENDS ${objlistfile})
153

L
liaogang 已提交
154 155
      list(APPEND mergebases "${mergebase}")
    endforeach()
156

L
liaogang 已提交
157
    add_library(${TARGET_NAME} STATIC ${mergebases})
158
    target_link_libraries(${TARGET_NAME} ${libs_deps})
159 160

    # Get the file name of the generated library
L
liaogang 已提交
161
    set(outlibfile "$<TARGET_FILE:${TARGET_NAME}>")
162

L
liaogang 已提交
163
    foreach(lib ${libs})
L
liaogang 已提交
164
      add_custom_command(TARGET ${TARGET_NAME} POST_BUILD
165
        COMMAND ${CMAKE_AR} cr ${outlibfile} *.o
166 167
        COMMAND ${CMAKE_RANLIB} ${outlibfile}
        WORKING_DIRECTORY ${lib}.objdir)
L
liaogang 已提交
168 169
    endforeach()
  endif()
170 171
endfunction(merge_static_libs)

L
liaogang 已提交
172
function(cc_library TARGET_NAME)
173
  set(options STATIC static SHARED shared)
L
liaogang 已提交
174 175 176
  set(oneValueArgs "")
  set(multiValueArgs SRCS DEPS)
  cmake_parse_arguments(cc_library "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
177 178 179 180 181 182 183 184
  if (cc_library_SRCS)
    if (cc_library_SHARED OR cc_library_shared) # build *.so
      add_library(${TARGET_NAME} SHARED ${cc_library_SRCS})
    else()
      add_library(${TARGET_NAME} STATIC ${cc_library_SRCS})
    endif()
    if (cc_library_DEPS)
      add_dependencies(${TARGET_NAME} ${cc_library_DEPS})
185
      target_link_libraries(${TARGET_NAME} ${cc_library_DEPS})
186 187 188 189 190 191 192 193
    endif()
  else(cc_library_SRCS)
    if (cc_library_DEPS)
      merge_static_libs(${TARGET_NAME} ${cc_library_DEPS})
    else()
      message(FATAL "Please specify source file or library in cc_library.")
    endif()
  endif(cc_library_SRCS)
L
liaogang 已提交
194 195
endfunction(cc_library)

L
liaogang 已提交
196
function(cc_binary TARGET_NAME)
197
  set(options "")
L
liaogang 已提交
198 199 200 201
  set(oneValueArgs "")
  set(multiValueArgs SRCS DEPS)
  cmake_parse_arguments(cc_binary "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  add_executable(${TARGET_NAME} ${cc_binary_SRCS})
202
  if(cc_binary_DEPS)
L
liaogang 已提交
203 204 205
    target_link_libraries(${TARGET_NAME} ${cc_binary_DEPS})
    add_dependencies(${TARGET_NAME} ${cc_binary_DEPS})
  endif()
L
liaogang 已提交
206 207
endfunction(cc_binary)

L
liaogang 已提交
208
function(cc_test TARGET_NAME)
209 210 211 212 213 214
  if(WITH_TESTING)
    set(options "")
    set(oneValueArgs "")
    set(multiValueArgs SRCS DEPS)
    cmake_parse_arguments(cc_test "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    add_executable(${TARGET_NAME} ${cc_test_SRCS})
Y
yi.wu 已提交
215
    target_link_libraries(${TARGET_NAME} ${cc_test_DEPS} gtest gtest_main)
L
liaogang 已提交
216
    add_dependencies(${TARGET_NAME} ${cc_test_DEPS} gtest gtest_main)
G
gongweibao 已提交
217
    add_test(NAME ${TARGET_NAME} COMMAND ${TARGET_NAME} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
L
liaogang 已提交
218
  endif()
L
liaogang 已提交
219
endfunction(cc_test)
L
liaogang 已提交
220 221

function(nv_library TARGET_NAME)
222
  if (WITH_GPU)
223
    set(options STATIC static SHARED shared)
224 225 226
    set(oneValueArgs "")
    set(multiValueArgs SRCS DEPS)
    cmake_parse_arguments(nv_library "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
227 228 229 230 231 232 233 234
    if(nv_library_SRCS)
      if (nv_library_SHARED OR nv_library_shared) # build *.so
        cuda_add_library(${TARGET_NAME} SHARED ${nv_library_SRCS})
      else()
          cuda_add_library(${TARGET_NAME} STATIC ${nv_library_SRCS})
      endif()
      if (nv_library_DEPS)
        add_dependencies(${TARGET_NAME} ${nv_library_DEPS})
235
        target_link_libraries(${TARGET_NAME} ${nv_library_DEPS})
236 237 238 239 240 241 242 243
      endif()
    else(nv_library_SRCS)
      if (nv_library_DEPS)
        merge_static_libs(${TARGET_NAME} ${nv_library_DEPS})
      else()
        message(FATAL "Please specify source file or library in nv_library.")
      endif()
    endif(nv_library_SRCS)
244
  endif()
L
liaogang 已提交
245 246 247
endfunction(nv_library)

function(nv_binary TARGET_NAME)
248 249 250 251 252 253 254 255 256 257
  if (WITH_GPU)
    set(options "")
    set(oneValueArgs "")
    set(multiValueArgs SRCS DEPS)
    cmake_parse_arguments(nv_binary "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    cuda_add_executable(${TARGET_NAME} ${nv_binary_SRCS})
    if(nv_binary_DEPS)
      target_link_libraries(${TARGET_NAME} ${nv_binary_DEPS})
      add_dependencies(${TARGET_NAME} ${nv_binary_DEPS})
    endif()
L
liaogang 已提交
258
  endif()
L
liaogang 已提交
259 260 261
endfunction(nv_binary)

function(nv_test TARGET_NAME)
262 263 264 265 266 267
  if (WITH_GPU AND WITH_TESTING)
    set(options "")
    set(oneValueArgs "")
    set(multiValueArgs SRCS DEPS)
    cmake_parse_arguments(nv_test "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
    cuda_add_executable(${TARGET_NAME} ${nv_test_SRCS})
L
liaogang 已提交
268 269
    target_link_libraries(${TARGET_NAME} ${nv_test_DEPS} gtest gtest_main)
    add_dependencies(${TARGET_NAME} ${nv_test_DEPS} gtest gtest_main)
270
    add_test(${TARGET_NAME} ${TARGET_NAME})
L
liaogang 已提交
271
  endif()
L
liaogang 已提交
272
endfunction(nv_test)
L
liaogang 已提交
273 274

function(go_library TARGET_NAME)
L
liaogang 已提交
275
  set(options STATIC static SHARED shared)
L
liaogang 已提交
276
  set(oneValueArgs "")
L
liaogang 已提交
277
  set(multiValueArgs DEPS)
L
liaogang 已提交
278
  cmake_parse_arguments(go_library "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
L
liaogang 已提交
279 280

  if (go_library_SHARED OR go_library_shared)
L
liaogang 已提交
281
    set(BUILD_MODE "-buildmode=c-shared")
H
Helin Wang 已提交
282
    set(${TARGET_NAME}_LIB_NAME "${CMAKE_SHARED_LIBRARY_PREFIX}${TARGET_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX}" CACHE STRING "output library name for target ${TARGET_NAME}")
L
liaogang 已提交
283 284
  else()
    set(BUILD_MODE "-buildmode=c-archive")
H
Helin Wang 已提交
285
    set(${TARGET_NAME}_LIB_NAME "${CMAKE_STATIC_LIBRARY_PREFIX}${TARGET_NAME}${CMAKE_STATIC_LIBRARY_SUFFIX}" CACHE STRING "output library name for target ${TARGET_NAME}")
L
liaogang 已提交
286
  endif()
L
liaogang 已提交
287

288
  # Add dummy code to support `make target_name` under Terminal Command
L
liaogang 已提交
289 290
  set(dummyfile ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}_dummy.c)
  file(WRITE ${dummyfile} "const char * dummy = \"${dummyfile}\";")
L
liaogang 已提交
291 292 293 294 295
  if (go_library_SHARED OR go_library_shared)
    add_library(${TARGET_NAME} SHARED ${dummyfile})
  else()
    add_library(${TARGET_NAME} STATIC ${dummyfile})
  endif()
296 297 298
  if(go_library_DEPS)
    add_dependencies(${TARGET_NAME} ${go_library_DEPS})
  endif(go_library_DEPS)
L
liaogang 已提交
299

H
Helin Wang 已提交
300 301
  set(${TARGET_NAME}_LIB_PATH "${CMAKE_CURRENT_BINARY_DIR}/${${TARGET_NAME}_LIB_NAME}" CACHE STRING "output library path for target ${TARGET_NAME}")

L
liaogang 已提交
302
  file(GLOB GO_SOURCE RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}" "*.go")
303
  string(REPLACE "${PADDLE_GO_PATH}/" "" CMAKE_CURRENT_SOURCE_REL_DIR ${CMAKE_CURRENT_SOURCE_DIR})
304

L
liaogang 已提交
305
  add_custom_command(TARGET ${TARGET_NAME} POST_BUILD
H
Helin Wang 已提交
306
    COMMAND rm "${${TARGET_NAME}_LIB_PATH}"
307
    # Golang build source code
Y
yi.wu 已提交
308
    COMMAND GOPATH=${GOPATH} ${CMAKE_Go_COMPILER} build ${BUILD_MODE}
H
Helin Wang 已提交
309
    -o "${${TARGET_NAME}_LIB_PATH}"
W
wuyi05 已提交
310 311
    "./${CMAKE_CURRENT_SOURCE_REL_DIR}/${GO_SOURCE}"
    # must run under GOPATH
312
    WORKING_DIRECTORY "${PADDLE_IN_GOPATH}/go")
313
  add_dependencies(${TARGET_NAME} go_vendor)
L
liaogang 已提交
314 315 316 317 318 319 320
endfunction(go_library)

function(go_binary TARGET_NAME)
  set(options OPTIONAL)
  set(oneValueArgs "")
  set(multiValueArgs SRCS DEPS)
  cmake_parse_arguments(go_binary "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
321
  string(REPLACE "${PADDLE_GO_PATH}/" "" CMAKE_CURRENT_SOURCE_REL_DIR ${CMAKE_CURRENT_SOURCE_DIR})
W
wuyi05 已提交
322

G
gongweibao 已提交
323
  # FIXME: link path
L
liaogang 已提交
324
  add_custom_command(OUTPUT ${TARGET_NAME}_timestamp
325 326
    COMMAND env LIBRARY_PATH=${CMAKE_BINARY_DIR}/go/pserver/client/c/:$ENV{LIBRARY_PATH}
    GOPATH=${GOPATH} ${CMAKE_Go_COMPILER} build
L
liaogang 已提交
327
    -o "${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}"
328
    "./${CMAKE_CURRENT_SOURCE_REL_DIR}/${go_binary_SRCS}"
G
gongweibao 已提交
329
    WORKING_DIRECTORY "${PADDLE_IN_GOPATH}/go")
W
wuyi05 已提交
330
  # TODO: don't know what ${TARGET_NAME}_link does
331
  add_custom_target(${TARGET_NAME} ALL DEPENDS go_vendor ${TARGET_NAME}_timestamp ${go_binary_DEPS})
L
liaogang 已提交
332 333 334 335 336 337
  install(PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME} DESTINATION bin)
endfunction(go_binary)

function(go_test TARGET_NAME)
  set(options OPTIONAL)
  set(oneValueArgs "")
338
  set(multiValueArgs DEPS)
L
liaogang 已提交
339
  cmake_parse_arguments(go_test "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
340 341 342
  string(REPLACE "${PADDLE_GO_PATH}" "" CMAKE_CURRENT_SOURCE_REL_DIR ${CMAKE_CURRENT_SOURCE_DIR})
  add_custom_target(${TARGET_NAME} ALL DEPENDS go_vendor ${go_test_DEPS})
  add_custom_command(TARGET ${TARGET_NAME} POST_BUILD
L
liaogang 已提交
343 344
    COMMAND env GOPATH=${GOPATH} ${CMAKE_Go_COMPILER} test
    -c -o "${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}"
345 346 347 348
    ".${CMAKE_CURRENT_SOURCE_REL_DIR}"
    WORKING_DIRECTORY "${PADDLE_IN_GOPATH}/go")
  add_test(NAME ${TARGET_NAME}
    COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${TARGET_NAME}
349
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
L
liaogang 已提交
350
endfunction(go_test)
Y
Yu Yang 已提交
351

Y
Yu Yang 已提交
352
function(proto_library TARGET_NAME)
Y
Yu Yang 已提交
353
  set(oneValueArgs "")
Y
Yu Yang 已提交
354
  set(multiValueArgs SRCS DEPS)
Y
Yu Yang 已提交
355
  cmake_parse_arguments(proto_library "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
Y
Yu Yang 已提交
356 357
  set(proto_srcs)
  set(proto_hdrs)
Y
Yu Yang 已提交
358
  protobuf_generate_cpp(proto_srcs proto_hdrs ${proto_library_SRCS})
Y
Yu Yang 已提交
359
  cc_library(${TARGET_NAME} SRCS ${proto_srcs} DEPS ${proto_library_DEPS} protobuf)
Y
Yu Yang 已提交
360
endfunction()
361 362 363 364 365 366 367 368

function(py_proto_compile TARGET_NAME)
  set(oneValueArgs "")
  set(multiValueArgs SRCS)
  cmake_parse_arguments(py_proto_compile "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  set(py_srcs)
  protobuf_generate_python(py_srcs ${py_proto_compile_SRCS})
  add_custom_target(${TARGET_NAME} ALL DEPENDS ${py_srcs})
369
endfunction()