CMakeLists.txt

   1 #
   2 #==================================================================================
   3 #       Copyright (c) 2019 Nokia
   4 #       Copyright (c) 2018-2019 AT&T Intellectual Property.
   5 #
   6 #   Licensed under the Apache License, Version 2.0 (the "License");
   7 #   you may not use this file except in compliance with the License.
   8 #   You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #   Unless required by applicable law or agreed to in writing, software
  13 #   distributed under the License is distributed on an "AS IS" BASIS,
  14 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #   See the License for the specific language governing permissions and
  16 #   limitations under the License.
  17 #==================================================================================
  18 #
  19
  20 project( rmr LANGUAGES C )
  21 cmake_minimum_required( VERSION 3.5 )
  22
  23 set( major_version "1" )                # should be automatically populated from git tag later, but until CI process sets a tag we use this
  24 set( minor_version "0" )
  25 set( patch_level "34" )
  26
  27 set( install_root "${CMAKE_INSTALL_PREFIX}" )
  28 set( install_lib "lib" )
  29 set( install_inc "include/rmr" )
  30 if( MAN_PREFIX )
  31         set( install_man ${MAN_PREFIX} )                        # is there a cmake var for this -- can't find one
  32 else()
  33         set( install_man "/usr/share/man" )                     # this needs to be fixed so it's not hard coded
  34 endif()
  35
  36 # Must use GNUInstallDirs to install libraries into correct
  37 # locations on all platforms.
  38 include( GNUInstallDirs )
  39
  40 # nano/nng install using LIBDIR as established by the gnu include; it varies from system
  41 # to system, and we don't trust that it is always set, so we default to lib.
  42 #
  43 if( NOT CMAKE_INSTALL_LIBDIR )
  44         set( CMAKE_INSTALL_LIBDIR "lib" )
  45 endif()
  46
  47 # ---------------- extract some things from git ------------------------------
  48
  49 # commit id for the version string
  50 execute_process(
  51         COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'"
  52         OUTPUT_VARIABLE git_id
  53 )
  54
  55 # version information for library names and version string
  56 execute_process(
  57         COMMAND bash -c "git describe --tags --abbrev=0 HEAD 2>/dev/null | awk -v tag=0.0.4095 ' { tag=$1 } END{ print  tag suffix }'|sed 's/\\./;/g' "
  58         OUTPUT_VARIABLE mmp_version_str
  59         ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE
  60 )
  61
  62 # extra indicator to show that the build was based on modified file(s) and not the true commit
  63 # (no hope of reproducing the exact library for debugging). Used only for the internal version
  64 # string.
  65 execute_process(
  66         COMMAND bash -c "git diff --shortstat|awk -v fmt=%s -v r=-rotten '{ s=r } END { printf( fmt, s ) }'"
  67         OUTPUT_VARIABLE spoiled_str
  68 )
  69
  70 # uncomment these lines once CI starts adding a tag on merge
  71 #set( mmp_version ${mmp_version_str} )
  72 #list( GET mmp_version 0 major_version )
  73 #list( GET mmp_version 1 minor_version )
  74 #list( GET mmp_version 2 patch_level )
  75
  76
  77 # define constants used in the version string
  78 add_definitions(
  79         -DGIT_ID=${git_id}
  80         -DMAJOR_VER=${major_version}
  81         -DMINOR_VER=${minor_version}
  82         -DPATCH_VER=${patch_level}${spoiled_str}
  83 )
  84
  85 # ---------------- suss out pkg gen tools so we don't fail generating packages that the system cannot support --------------
  86
  87
  88 if( DEV_PKG )
  89         set( dev_tag "-dev" )
  90 endif()
  91 set( pkg_label "${CMAKE_PROJECT_NAME}-${major_version}.${minor_version}.${patch_level}.${CMAKE_SYSTEM_PROCESSOR}${dev_tag}" )
  92 message( "+++ building ${pkg_label}${spoiled_str}" )
  93 set( out_yml /tmp/build_output.yml )                                    # we will record package names (we record only untainted names)
  94 find_program( rpm NAMES rpmbuild )                                              # rpm package gen requires this to be installed
  95
  96 set( gen_rpm 0 )
  97 if( "${rpm}" MATCHES "rpm-NOTFOUND" )                          # cannot build rpm
  98         set( pkg_list "DEB" )
  99         message( "### make package will generate only deb package; cannot find support to generate rpm packages" )
 100 else()
 101         set( pkg_list "DEB;RPM" )
 102         set( gen_rpm 1 )
 103         message( "+++ make package will generate both deb and rpm packages" )
 104 endif()
 105
 106 execute_process(
 107         COMMAND bash -c "printf '# RMr build generated list of package paths\n---\n' >${out_yml}"
 108 )
 109
 110 execute_process(
 111         COMMAND bash -c " echo deb: ${CMAKE_CURRENT_BINARY_DIR}/${pkg_label}.deb  >>${out_yml}"
 112 )
 113
 114 if( gen_rpm )
 115         execute_process(
 116                 COMMAND bash -c " echo rpm: ${CMAKE_CURRENT_BINARY_DIR}/${pkg_label}.rpm  >>${out_yml}"
 117         )
 118 endif()
 119
 120 execute_process(
 121         COMMAND bash -c "printf '...\n' >>${out_yml}"
 122 )
 123
 124 # ---------------- setup nano/nng things ---------------------------------------
 125 if( NOT SKIP_EXTERNALS )
 126         set( need_ext 1 )                               # we force dependences on these for right build order
 127     execute_process( COMMAND  git submodule update --init -- ext/nng
 128             WORKING_DIRECTORY  ${CMAKE_CURRENT_SOURCE_DIR}
 129     )
 130
 131     execute_process( COMMAND  git submodule update --init -- ext/nanomsg
 132             WORKING_DIRECTORY  ${CMAKE_CURRENT_SOURCE_DIR}
 133     )
 134     if( NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/ext/nng/CMakeLists.txt )
 135         message( FATAL_ERROR "cannot find nng in our git source as a submodule: Giving up" )    # this will abort which seems wrong, but tdam.
 136     endif()
 137
 138         include( ExternalProject )
 139         ExternalProject_Add(
 140                 ext_nng
 141                 SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ext/nng"
 142                 CMAKE_ARGS "-DBUILD_SHARED_LIBS=1"
 143                 CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_CURRENT_BINARY_DIR}"
 144                 BUILD_COMMAND "make"
 145                 UPDATE_COMMAND ""
 146                 TEST_COMMAND ""
 147                 STEP_TARGETS build
 148         )
 149         ExternalProject_Add(
 150                 nanomsg
 151                 SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ext/nanomsg"
 152                 BUILD_COMMAND "make"
 153                 UPDATE_COMMAND ""
 154                 CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_CURRENT_BINARY_DIR}"
 155                 TEST_COMMAND ""
 156                 STEP_TARGETS build
 157         )
 158
 159         # it seems impossible to install everything that lands in {bin}/lib, so we need to
 160         # hard code (shudder) some things. Even worse, we have to make exceptions for
 161         # builds on apple (osx) since their naming convention wandered off the path.
 162         set( nng_major 1 )
 163         set( nng_minor 1.0 )
 164         set( nano_major 5 )
 165         set( nano_minor 1.0 )
 166         set( so ${CMAKE_SHARED_LIBRARY_SUFFIX} )        # cmake variables are impossibly long :(
 167         if( NOT APPLE )                                 # probably breaks in windows, but idc
 168                 set( nng_so_suffix ${so} )
 169                 set( nng_so_suffix_m ${so}.${nng_major} )
 170                 set( nng_so_suffix_mm ${so}.${nng_major}.${nng_minor} )
 171
 172                 set( nano_so_suffix ${so} )
 173                 set( nano_so_suffix_m ${so}.${nano_major} )
 174                 set( nano_so_suffix_mm ${so}.${nano_major}.${nano_minor} )
 175         else()
 176                 # of course apple puts versions before the suffix :(
 177                 set( nng_so_suffix ${so} )                                                                      # so has a lead dot, so NOT needed
 178                 set( nng_so_suffix_m ".${nng_major}${so}" )                                     # these need leading dots
 179                 set( nng_so_suffix_mm ".${nng_major}.${nng_minor}${so}" )
 180
 181                 set( nano_so_suffix ${so} )
 182                 set( nano_so_suffix_m ".${nano_major}${so}" )
 183                 set( nano_so_suffix_mm ".${nano_major}.${nano_minor}${so}" )
 184         endif()
 185
 186         message( "+++ installing nano/nng with: ${nano_major}.${nano_minor} | ${nng_major}.${nng_minor}" )
 187 else()
 188         if( PACK_EXTERNALS )
 189                 unset( SKIP_EXTERNALS  CACHE )  # must remove so as not to trap user into a never ending failure
 190                 unset( PACK_EXTERNALS  CACHE )
 191                 message( FATAL_ERROR "ERROR: PACK_EXTERNALS can be set only if SKIP_EXTERNALS is unset (=0, or not supplied on command line)" )
 192         endif()
 193         set( need_ext 0 )
 194 endif()
 195
 196 unset( SKIP_EXTERNALS  CACHE )  # prevent these from being applied next build unless specifically set on comd line
 197 unset( PACK_EXTERNALS  CACHE )
 198
 199
 200 # this gets us round a chicken/egg problem. include files don't exist until make is run
 201 # but Cmake insists on having these exist when we add them to include directories to
 202 # enable rmr code to find them after we build them.
 203 #
 204 execute_process( COMMAND "mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/include/nng" )
 205 include_directories( "${CMAKE_CURRENT_BINARY_DIR}/include" )
 206
 207
 208 # Compiler flags
 209 #
 210 set( CMAKE_POSITION_INDEPENDENT_CODE ON )
 211 set( CMAKE_CXX_FLAGS "-g -Wall " )
 212
 213 # Include modules
 214 add_subdirectory( src/rmr/common )
 215 add_subdirectory( src/rmr/nanomsg )
 216 add_subdirectory( src/rmr/nng )
 217 add_subdirectory( doc )                         # this will auto skip if {X}fm is not available
 218
 219
 220 # shared and static libraries are built from the same object files.
 221 # Nanomsg based library (librmr ) while nng based is librmr_nng.
 222 # library is built by pulling object files from either the nano or nng  and common subdirs
 223 #
 224 add_library( rmr_shared SHARED "$<TARGET_OBJECTS:nano_objects>;$<TARGET_OBJECTS:common_objects>" )
 225
 226 set_target_properties( rmr_shared
 227         PROPERTIES
 228                 OUTPUT_NAME "rmr"
 229                 SOVERSION ${major_version}
 230                 VERSION ${major_version}.${minor_version}.${patch_level} )
 231
 232 add_library( rmr_nng_shared SHARED "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
 233 set_target_properties( rmr_nng_shared
 234         PROPERTIES
 235         OUTPUT_NAME "rmr_nng"
 236         SOVERSION ${major_version}
 237         VERSION ${major_version}.${minor_version}.${patch_level} )
 238
 239 # we only build/export the static archive (.a) if generating a dev package
 240 if( DEV_PKG )
 241         add_library( rmr_nng_static STATIC "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
 242         set_target_properties( rmr_nng_static
 243                 PROPERTIES
 244                 OUTPUT_NAME "rmr_nng"
 245                 SOVERSION ${major_version}
 246                 VERSION ${major_version}.${minor_version}.${patch_level} )
 247
 248         add_library( rmr_static STATIC "$<TARGET_OBJECTS:nano_objects>;$<TARGET_OBJECTS:common_objects>" )
 249
 250         set_target_properties( rmr_static
 251                 PROPERTIES
 252                 OUTPUT_NAME "rmr"
 253                 SOVERSION ${major_version}
 254                 VERSION ${major_version}.${minor_version}.${patch_level} )
 255 endif()
 256
 257 # if externals need to be built, then we must force them to be built first by depending on them
 258 if( need_ext )
 259         if( DEV_PKG )
 260                 add_dependencies( rmr_static;rmr_shared nanomsg )
 261                 add_dependencies( rmr_nng_shared;rmr_nng_static ext_nng )
 262         else()
 263                 add_dependencies( rmr_shared nanomsg )
 264                 add_dependencies( rmr_nng_shared ext_nng )
 265         endif()
 266 endif()
 267
 268 #
 269 if( APPLE  )
 270         message( "### apple hack: forcing hard coded library paths for nng/nano dynamic libraries" )
 271         target_link_libraries( rmr_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnanomsg${nano_so_suffix} )
 272         target_link_libraries( rmr_nng_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnng${nng_so_suffix} )
 273 endif()
 274
 275 # Define directories where package should drop things when installed
 276 # In CMake speak archive == *.a  library == *.so, so both are needed
 277 # Headers from the common directory are forced to install by the local CM file in common. At
 278 # the moment, there are no header files specific to either nano or nng, so to the public
 279 # header directive is moot, but needed if some day there is one.
 280 #
 281 if( DEV_PKG )
 282         set( target_list "rmr_nng_shared;rmr_nng_static;rmr_shared;rmr_static" )
 283 else()
 284         set( target_list "rmr_nng_shared;rmr_shared" )
 285 endif()
 286
 287 install( TARGETS ${target_list} EXPORT LibraryConfig
 288         LIBRARY  DESTINATION ${install_lib}
 289         ARCHIVE  DESTINATION ${install_lib}
 290         PUBLIC_HEADER DESTINATION ${install_inc}
 291 )
 292
 293
 294 unset( DEV_PKG  CACHE )                 # prevent from being a hiddent setting if user redoes things
 295
 296 # install any nano/nng libraries in to the deb as well, but ONLY if asked for on the 'cmake ..' command
 297 # (sure would be nice if FILEs allowed for globbing; sadlyy it does not.)
 298 #
 299 if( PACK_EXTERNALS )
 300         message( "including nano and nng libraries in the deb" )
 301         install( FILES
 302                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnanomsg${nano_so_suffix}
 303                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnanomsg${nano_so_suffix_m}
 304                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnanomsg${nano_so_suffix_mm}
 305                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix}
 306                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_m}
 307                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_mm}
 308
 309                 DESTINATION ${install_lib}
 310         )
 311 endif()
 312
 313 IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" )
 314         include( InstallRequiredSystemLibraries )
 315
 316         set( CPACK_set_DESTDIR "on" )
 317         set( CPACK_PACKAGING_INSTALL_PREFIX "${install_root}" )
 318         set( CPACK_GENERATOR "${pkg_list}" )
 319
 320         set( CPACK_PACKAGE_DESCRIPTION "Thin library for RIC xAPP messaging routed based on message type." )
 321         set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "RIC message routing library" )
 322         set( CPACK_PACKAGE_VENDOR "None" )
 323         set( CPACK_PACKAGE_CONTACT "None" )
 324         set( CPACK_PACKAGE_VERSION_MAJOR "${major_version}" )
 325         set( CPACK_PACKAGE_VERSION_MINOR "${minor_version}" )
 326         set( CPACK_PACKAGE_VERSION_PATCH "${patch_level}" )
 327         set( CPACK_PACKAGE_FILE_NAME "${pkg_label}${spoiled_str}" )
 328
 329         # we build and ship the libraries, so there is NO dependency
 330
 331         set( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" )
 332         set( CPACK_DEBIAN_PACKAGE_SECTION "ric" )
 333         set( CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
 334         set( CPACK_RPM_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
 335
 336         # this seems ingnored if included
 337         #set( CPACK_COMPONENTS_ALL Libraries ApplicationData )
 338
 339         INCLUDE( CPack )
 340 ENDIF()