CMakeLists.txt

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