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 # This CMake definition supports several -D command line options:
  21 #
  22 #       -DDEBUG=n                       Enable debugging level n
  23 #       -DDEV_PKG=1                     Development package configuration
  24 #       -DBUILD_DOC=1           Man pages generated
  25 #       -DIGNORE_LIBDIR=1       Installation of rmr libries is into /usr/local/lib and ignores
  26 #                                               value in CMAKE_INSTALL_LIBDIR.
  27 #                                               system preferred (typically /usr/local/lib64).
  28 #       -DPRESERVE_PTYPE=1      Do not change the processor type when naming deb packages
  29 #       -DPACK_EXTERNALS=1      Include external libraries used to build in the run-time package
  30 #                                               (This makes some stand-alone unit testing of bindings possible, it
  31 #                                               is not meant to be used for production package generation.)
  32 #       -DGPROF=1                       Enable profiling compile time flags
  33 #       -DSKIP_EXTERNALS=1      Do not use NNG submodule when building; uee installed packages
  34 #       -DMAN_PREFIX=<path>     Supply a path where man pages are installed (default: /usr/share/man)
  35
  36 #       See ci/build_all for an example of how to build and test
  37
  38 project( rmr LANGUAGES C )
  39 cmake_minimum_required( VERSION 3.5 )
  40
  41 set( major_version "3" )                # should be automatically populated from git tag later, but until CI process sets a tag we use this
  42 set( minor_version "7" )
  43 set( patch_level "4" )
  44
  45 set( install_root "${CMAKE_INSTALL_PREFIX}" )
  46 set( install_inc "include/rmr" )
  47 if( MAN_PREFIX )
  48         set( install_man ${MAN_PREFIX} )                        # is there a cmake var for this -- can't find one
  49 else()
  50         set( install_man "/usr/share/man" )                     # this needs to be fixed so it's not hard coded
  51 endif()
  52
  53 # Must use GNUInstallDirs to install libraries into correct
  54 # locations on all platforms.
  55 include( GNUInstallDirs )
  56
  57 # nng installs using LIBDIR as established by the gnu include; it varies from system
  58 # to system, and we don't trust that it is always set, so we default to lib if it is missing.
  59 #
  60 if( NOT CMAKE_INSTALL_LIBDIR )
  61         set( CMAKE_INSTALL_LIBDIR "lib" )
  62 endif()
  63
  64 if( IGNORE_LIBDIR )                                     # if set, then force to lib otherwise use "system preference"
  65         set( install_lib "lib" )
  66 else()
  67         set( install_lib "${CMAKE_INSTALL_LIBDIR}" )
  68 endif()
  69 unset(IGNORE_LIBDIR CACHE )                                     # we don't want this to persist
  70 message( "+++ RMR library install target directory: ${install_lib}" )
  71
  72 # ---------------- extract some things from git ------------------------------
  73
  74 # commit id for the version string
  75 execute_process(
  76         COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'"
  77         OUTPUT_VARIABLE git_id
  78 )
  79
  80 # version information for library names and version string
  81 execute_process(
  82         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' "
  83         OUTPUT_VARIABLE mmp_version_str
  84         ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE
  85 )
  86 message( "+++ mmp version from tag: '${mmp_version_str}'" )
  87
  88 # extra indicator to show that the build was based on modified file(s) and not the true commit
  89 # (no hope of reproducing the exact library for debugging). Used only for the internal version
  90 # string.
  91 execute_process(
  92         COMMAND bash -c "git diff --shortstat|awk -v fmt=%s -v r=-rotten '{ s=r } END { printf( fmt, s ) }'"
  93         OUTPUT_VARIABLE spoiled_str
  94 )
  95
  96 # uncomment these lines once CI starts adding a tag on merge
  97 #set( mmp_version ${mmp_version_str} )
  98 #list( GET mmp_version 0 major_version )
  99 #list( GET mmp_version 1 minor_version )
 100 #list( GET mmp_version 2 patch_level )
 101
 102 if( DEBUG )                                     # if set, we'll set debugging on in the compile
 103         set( debugging ${DEBUG} )
 104         message( "+++ debugging is being set to ${DEBUG}" )
 105 else()
 106         set( debugging 0 )
 107         message( "+++ debugging is set to off" )
 108 endif()
 109 unset( DEBUG CACHE )                                    # we don't want this to persist
 110
 111
 112 # define constants used in the version string, debugging, etc.
 113 add_definitions(
 114         -DGIT_ID=${git_id}
 115         -DMAJOR_VER=${major_version}
 116         -DMINOR_VER=${minor_version}
 117         -DPATCH_VER=${patch_level}
 118         -DDEBUG=${debugging}
 119 )
 120
 121 # ---------------- suss out pkg gen tools so we don't fail generating packages that the system cannot support --------------
 122
 123 # deb packages use underbars, and package manager(s) seem to flip the *_64 processor type
 124 # to the old (non-standard) amd64 string, so we do it here for consistency. Set -DPRESERVE_PTYPE=1
 125 # to prevent the flip. RPM packages will always be given the system generated processor type string.
 126 #
 127 if( ${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64" )
 128         if( NOT PRESERVE_PTYPE )
 129                 set( deb_sys_name "amd64" )
 130         else()
 131                 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
 132         endif()
 133 else()
 134         set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
 135 endif()
 136 unset( PRESERVE_PTYPE CACHE )                                   # we don't want this to persist
 137
 138 set( rpm_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
 139
 140 if( DEV_PKG )
 141         set( deb_pkg_name "rmr-dev" )
 142         set( rpm_pkg_name "rmr-devel" )
 143 else()
 144         set( deb_pkg_name "rmr" )
 145         set( rpm_pkg_name "rmr" )
 146 endif()
 147
 148 set( pkg_label "rmr${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${sys_name}" )
 149 set( rpm_pkg_label "${rpm_pkg_name}${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${rpm_sys_name}" )
 150 set( deb_pkg_label "${deb_pkg_name}${spoiled_str}_${major_version}.${minor_version}.${patch_level}_${deb_sys_name}" )
 151 message( "+++ pkg name: ${deb_pkg_label}.deb" )
 152
 153 #set( out_yml /tmp/build_output.yml )                                   # we will record package names (we record only untainted names)
 154 find_program( rpm NAMES rpmbuild )                                              # rpm package gen requires this to be installed
 155
 156 set( gen_rpm 0 )
 157 if( "${rpm}" MATCHES "rpm-NOTFOUND" )                          # cannot build rpm
 158         set( pkg_list "DEB" )
 159         message( "### make package will generate only deb package; cannot find support to generate rpm packages" )
 160 else()
 161         message( "+++ pkg name: ${rpm_pkg_label}.rpm" )         # debugging if we think we can gen rpm too
 162         set( pkg_list "DEB;RPM" )
 163         set( gen_rpm 1 )
 164         message( "+++ make package will generate both deb and rpm packages" )
 165 endif()
 166
 167 # ---------------- setup nano/nng things ---------------------------------------
 168 if( NOT SKIP_EXTERNALS )
 169         set( need_ext 1 )                               # we force dependences on these for right build order
 170     execute_process( COMMAND  git submodule update --init -- ext/nng
 171             WORKING_DIRECTORY  ${CMAKE_CURRENT_SOURCE_DIR}
 172     )
 173
 174     if( NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/ext/nng/CMakeLists.txt )
 175         message( FATAL_ERROR "cannot find nng in our git source as a submodule: Giving up" )    # this will abort which seems wrong, but tdam.
 176     endif()
 177
 178         include( ExternalProject )
 179         ExternalProject_Add(
 180                 ext_nng
 181                 SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ext/nng"
 182                 CMAKE_ARGS "-DBUILD_SHARED_LIBS=1"
 183                 CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_CURRENT_BINARY_DIR}"
 184                 BUILD_COMMAND "make"
 185                 UPDATE_COMMAND ""
 186                 TEST_COMMAND ""
 187                 STEP_TARGETS build
 188         )
 189
 190         # it seems impossible to install everything that lands in {bin}/lib, so we need to
 191         # hard code (shudder) some things. Even worse, we have to make exceptions for
 192         # builds on apple (osx) since their naming convention wandered off the path.
 193         set( nng_major 1 )
 194         set( nng_minor 1.0 )
 195         set( so ${CMAKE_SHARED_LIBRARY_SUFFIX} )        # cmake variables are impossibly long :(
 196         if( NOT APPLE )                                 # probably breaks in windows, but idc
 197                 set( nng_so_suffix ${so} )
 198                 set( nng_so_suffix_m ${so}.${nng_major} )
 199                 set( nng_so_suffix_mm ${so}.${nng_major}.${nng_minor} )
 200         else()
 201                 # of course apple puts versions before the suffix :(
 202                 set( nng_so_suffix ${so} )                                                                      # so has a lead dot, so NOT needed
 203                 set( nng_so_suffix_m ".${nng_major}${so}" )                                     # these need leading dots
 204                 set( nng_so_suffix_mm ".${nng_major}.${nng_minor}${so}" )
 205         endif()
 206
 207         message( "+++ building with nng: ${nng_major}.${nng_minor}" )
 208 else()
 209         if( PACK_EXTERNALS )
 210                 # This makes some stand-alone unit testing possible for bindings and transport layer testing;
 211                 # it is not meant for production packages.
 212                 #
 213                 unset( SKIP_EXTERNALS  CACHE )  # must remove so as not to trap user into a never ending failure
 214                 unset( PACK_EXTERNALS  CACHE )
 215                 message( FATAL_ERROR "ERROR: PACK_EXTERNALS can be set only if SKIP_EXTERNALS is unset (=0, or not supplied on command line)" )
 216         endif()
 217         set( need_ext 0 )
 218 endif()
 219
 220
 221
 222 # this gets us round a chicken/egg problem. include files don't exist until make is run
 223 # but Cmake insists on having these exist when we add them to include directories to
 224 # enable rmr code to find them after we build them.
 225 #
 226 execute_process( COMMAND "mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/include/nng" )
 227 include_directories( "${CMAKE_CURRENT_BINARY_DIR}/include" )
 228
 229
 230 # Compiler flags
 231 #
 232 set( CMAKE_POSITION_INDEPENDENT_CODE ON )
 233 #set( CMAKE_C_FLAGS "-g -Wall " )
 234 #set( CMAKE_C_FLAGS "-g " )
 235 if( GPROF )                                     # if set, we'll set profiling flag on compiles
 236         message( "+++ profiling is on" )
 237         set( CMAKE_C_FLAGS "-pg " )
 238 else()
 239         message( "+++ profiling is off" )
 240         set( CMAKE_C_FLAGS "-g " )
 241 endif()
 242 unset( GPROF CACHE )                                    # we don't want this to persist
 243
 244 # Include modules
 245 add_subdirectory( src/rmr/common )
 246 add_subdirectory( src/rmr/nng )
 247 add_subdirectory( src/rmr/si )
 248 add_subdirectory( doc )                         # this will auto skip if {X}fm is not available
 249
 250
 251 # shared and static libraries are built from the same object files.
 252 # librmr_nng is a combination of common and nng specific rmr functions.
 253 #
 254
 255 add_library( rmr_nng_shared SHARED "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
 256 set_target_properties( rmr_nng_shared
 257         PROPERTIES
 258         OUTPUT_NAME "rmr_nng"
 259         SOVERSION ${major_version}
 260         VERSION ${major_version}.${minor_version}.${patch_level} )
 261
 262 # we only build/export the static archive (.a) if generating a dev package
 263 if( DEV_PKG )
 264         add_library( rmr_nng_static STATIC "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
 265         set_target_properties( rmr_nng_static
 266                 PROPERTIES
 267                 OUTPUT_NAME "rmr_nng"
 268                 SOVERSION ${major_version}
 269                 VERSION ${major_version}.${minor_version}.${patch_level} )
 270 endif()
 271
 272 add_library( rmr_si_shared SHARED "$<TARGET_OBJECTS:rmr_si_objects>;$<TARGET_OBJECTS:common_objects>" )
 273 set_target_properties( rmr_si_shared
 274         PROPERTIES
 275         OUTPUT_NAME "rmr_si"
 276         SOVERSION ${major_version}
 277         VERSION ${major_version}.${minor_version}.${patch_level} )
 278
 279 # even if not generating a development package we still need to generate the .a so that health check
 280 # can link against it to avoid RPM install issues.
 281 #
 282 add_library( rmr_si_static STATIC "$<TARGET_OBJECTS:rmr_si_objects>;$<TARGET_OBJECTS:common_objects>" )
 283 set_target_properties( rmr_si_static
 284         PROPERTIES
 285         OUTPUT_NAME "rmr_si"
 286         SOVERSION ${major_version}
 287         VERSION ${major_version}.${minor_version}.${patch_level} )
 288
 289 # if externals need to be built, then we must force them to be built first by depending on them
 290 if( need_ext )
 291         if( DEV_PKG )
 292                 add_dependencies( rmr_nng_shared;rmr_nng_static ext_nng )
 293         else()
 294                 add_dependencies( rmr_nng_shared ext_nng )
 295         endif()
 296 endif()
 297
 298 # ------------- testing -------------------------------------------------------
 299 enable_testing()
 300 # cmake cannot set env vars, so we have to passed desired vars on the wrapper command
 301 add_test(
 302                 NAME drive_unit_tests
 303                 COMMAND bash ../test/run_unit_tests.sh CMBUILD=${CMAKE_CURRENT_BINARY_DIR}
 304                 WORKING_DIRECTORY ../test
 305 )
 306
 307 # cmake seems unable to start test/app_test/run_all.ksh, so we have to lump
 308 # a dummy script in ./test that does the obvious thing.
 309 add_test(
 310                 NAME drive_app
 311                 COMMAND bash  ./run_app_tests.sh LD_LIBRARY_PATH=${install_root}/lib C_INCLUDE_PATH=${install_root}/include CMBUILD=${CMAKE_CURRENT_BINARY_DIR}
 312                 WORKING_DIRECTORY ../test
 313 )
 314
 315
 316 # --- support binaries that depend on the libs identified above ---------------
 317 add_subdirectory( src/support )
 318
 319 # ------------- packaging -----------------------------------------------------
 320
 321 #
 322 if( APPLE  )
 323         message( "### apple hack: forcing hard coded library paths for nng/nano dynamic libraries" )
 324         target_link_libraries( rmr_nng_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnng${nng_so_suffix} )
 325 endif()
 326
 327 # Define what should be installed, and where they should go. For dev package we install
 328 # only the RMr headers, man pages and archive (.a) files.  The run-time package gets just
 329 # the library (.so) files and nothing more.
 330 #
 331 if( DEV_PKG )
 332         set( target_list "rmr_nng_static;rmr_si_static" )
 333 else()
 334         set( target_list "rmr_nng_shared;rmr_si_shared" )
 335 endif()
 336
 337 install( TARGETS ${target_list} EXPORT LibraryConfig
 338         LIBRARY  DESTINATION ${install_lib}
 339         ARCHIVE  DESTINATION ${install_lib}
 340         PUBLIC_HEADER DESTINATION ${install_inc}
 341 )
 342
 343
 344 unset( DEV_PKG  CACHE )                 # prevent from being a hidden setting if user redoes things
 345
 346 # install any nano/nng libraries in to the deb as well, but ONLY if asked for on the 'cmake ..' command
 347 # (sure would be nice if FILEs allowed for globbing; sadly it does not.)
 348 #
 349 if( PACK_EXTERNALS )
 350         message( "+++ including nano and nng libraries in the deb" )
 351         install( FILES
 352                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix}
 353                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_m}
 354                 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_mm}
 355
 356                 DESTINATION ${install_lib}
 357         )
 358 endif()
 359
 360 unset( SKIP_EXTERNALS  CACHE )  # prevent these from being applied next build unless specifically set on comd line
 361 unset( PACK_EXTERNALS  CACHE )
 362
 363 IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" )
 364         include( InstallRequiredSystemLibraries )
 365
 366         set( CPACK_DEBIAN_PACKAGE_NAME ${deb_pkg_name} )
 367         set( CPACK_RPM_PACKAGE_NAME ${rpm_pkg_name} )
 368
 369         # auto dependency checking makes the RPM install fail, see NOTES
 370         set( CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION="/usr/local /usr/local/bin /usr/local/lib" )
 371
 372         set( CPACK_set_DESTDIR "on" )
 373         set( CPACK_PACKAGING_INSTALL_PREFIX "${install_root}" )
 374         set( CPACK_GENERATOR "${pkg_list}" )
 375
 376         set( CPACK_PACKAGE_DESCRIPTION "Thin library for RIC xAPP messaging routed based on message type." )
 377         set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "RIC message routing library" )
 378         set( CPACK_PACKAGE_VENDOR "None" )
 379         set( CPACK_PACKAGE_CONTACT "None" )
 380         set( CPACK_PACKAGE_VERSION_MAJOR "${major_version}" )
 381         set( CPACK_PACKAGE_VERSION_MINOR "${minor_version}" )
 382         set( CPACK_PACKAGE_VERSION_PATCH "${patch_level}" )
 383         set( CPACK_PACKAGE "${pkg_label}" )                                             # generic name for old versions of cpack
 384         set( CPACK_DEBIAN_FILE_NAME "${deb_pkg_label}.deb" )
 385         set( CPACK_RPM_FILE_NAME "${rpm_pkg_label}.rpm" )
 386
 387         # there is not an NNG package, so we cannot define a dependency
 388
 389         set( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" )
 390         set( CPACK_DEBIAN_PACKAGE_SECTION "ric" )
 391         set( CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
 392         set( CPACK_RPM_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
 393
 394         # this seems ingnored if included
 395         #set( CPACK_COMPONENTS_ALL Libraries ApplicationData )
 396
 397         INCLUDE( CPack )
 398 ENDIF()