X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=CMakeLists.txt;h=ae986c9baf6b77ff670c86b82e9e5321f18c6bce;hb=116d0f5b6c5b1a396fed835c714a5d568c264cc5;hp=c34f17a77b1807bd90a89ff8c2988376e26536eb;hpb=68c5cf1104e89f5c43786a3e48f5c6a1e757f59f;p=ric-plt%2Flib%2Frmr.git diff --git a/CMakeLists.txt b/CMakeLists.txt index c34f17a..ae986c9 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,6 @@ - # #================================================================================== -# Copyright (c) 2019 Nokia +# Copyright (c) 2019 Nokia # Copyright (c) 2018-2019 AT&T Intellectual Property. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -18,16 +17,32 @@ #================================================================================== # +# This CMake definition supports several -D command line options: +# +# -DDEBUG=n Enable debugging level n +# -DDEV_PKG=1 Development package configuration +# -DBUILD_DOC=1 Man pages generated +# -DIGNORE_LIBDIR=1 Installation of rmr libries is into /usr/local/lib and ignores +# value in CMAKE_INSTALL_LIBDIR. +# system preferred (typically /usr/local/lib64). +# -DPRESERVE_PTYPE=1 Do not change the processor type when naming deb packages +# -DPACK_EXTERNALS=1 Include external libraries used to build in the run-time package +# (This makes some stand-alone unit testing of bindings possible, it +# is not meant to be used for production package generation.) +# -DGPROF=1 Enable profiling compile time flags +# -DSKIP_EXTERNALS=1 Do not use NNG submodule when building; uee installed packages +# -DMAN_PREFIX= Supply a path where man pages are installed (default: /usr/share/man) + +# See ci/build_all for an example of how to build and test + project( rmr LANGUAGES C ) cmake_minimum_required( VERSION 3.5 ) - -set( major_version "0" ) # automatically populated from git tag later -set( minor_version "0" ) -set( patch_level "0" ) +set( major_version "3" ) # should be automatically populated from git tag later, but until CI process sets a tag we use this +set( minor_version "6" ) +set( patch_level "2" ) set( install_root "${CMAKE_INSTALL_PREFIX}" ) -set( install_lib "lib" ) set( install_inc "include/rmr" ) if( MAN_PREFIX ) set( install_man ${MAN_PREFIX} ) # is there a cmake var for this -- can't find one @@ -39,48 +54,115 @@ endif() # locations on all platforms. include( GNUInstallDirs ) -if( NOT BUILD_LIB ) - set( BUILD_LIB lib ) +# nng installs using LIBDIR as established by the gnu include; it varies from system +# to system, and we don't trust that it is always set, so we default to lib if it is missing. +# +if( NOT CMAKE_INSTALL_LIBDIR ) + set( CMAKE_INSTALL_LIBDIR "lib" ) +endif() + +if( IGNORE_LIBDIR ) # if set, then force to lib otherwise use "system preference" + set( install_lib "lib" ) +else() + set( install_lib "${CMAKE_INSTALL_LIBDIR}" ) endif() +unset(IGNORE_LIBDIR CACHE ) # we don't want this to persist +message( "+++ RMR library install target directory: ${install_lib}" ) # ---------------- extract some things from git ------------------------------ # commit id for the version string -execute_process( - COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'" +execute_process( + COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'" OUTPUT_VARIABLE git_id ) # version information for library names and version string -execute_process( +execute_process( 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' " OUTPUT_VARIABLE mmp_version_str ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE ) +message( "+++ mmp version from tag: '${mmp_version_str}'" ) # extra indicator to show that the build was based on modified file(s) and not the true commit -# (no hope of reproducing the exact library for debugging). Used only for the internal version +# (no hope of reproducing the exact library for debugging). Used only for the internal version # string. -execute_process( - COMMAND bash -c "git diff --shortstat|awk -v fmt=%s -v r=-rotten '{ s=r } END { printf( fmt, s ) }'" +execute_process( + COMMAND bash -c "git diff --shortstat|awk -v fmt=%s -v r=-rotten '{ s=r } END { printf( fmt, s ) }'" OUTPUT_VARIABLE spoiled_str ) -set( mmp_version ${mmp_version_str} ) -list( GET mmp_version 0 major_version ) -list( GET mmp_version 1 minor_version ) -list( GET mmp_version 2 patch_level ) +# uncomment these lines once CI starts adding a tag on merge +#set( mmp_version ${mmp_version_str} ) +#list( GET mmp_version 0 major_version ) +#list( GET mmp_version 1 minor_version ) +#list( GET mmp_version 2 patch_level ) -message( "+++ building ${major_version}.${minor_version}.${patch_level}${spoiled_str}" ) +if( DEBUG ) # if set, we'll set debugging on in the compile + set( debugging ${DEBUG} ) + message( "+++ debugging is being set to ${DEBUG}" ) +else() + set( debugging 0 ) + message( "+++ debugging is set to off" ) +endif() +unset( DEBUG CACHE ) # we don't want this to persist -# define constants used in the version string -add_definitions( - -DGIT_ID=${git_id} + +# define constants used in the version string, debugging, etc. +add_definitions( + -DGIT_ID=${git_id} -DMAJOR_VER=${major_version} -DMINOR_VER=${minor_version} - -DPATCH_VER=${patch_level}${spoiled_str} + -DPATCH_VER=${patch_level} + -DDEBUG=${debugging} ) +# ---------------- suss out pkg gen tools so we don't fail generating packages that the system cannot support -------------- + +# deb packages use underbars, and package manager(s) seem to flip the *_64 processor type +# to the old (non-standard) amd64 string, so we do it here for consistency. Set -DPRESERVE_PTYPE=1 +# to prevent the flip. RPM packages will always be given the system generated processor type string. +# +if( ${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64" ) + if( NOT PRESERVE_PTYPE ) + set( deb_sys_name "amd64" ) + else() + set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} ) + endif() +else() + set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} ) +endif() +unset( PRESERVE_PTYPE CACHE ) # we don't want this to persist + +set( rpm_sys_name ${CMAKE_SYSTEM_PROCESSOR} ) + +if( DEV_PKG ) + set( deb_pkg_name "rmr-dev" ) + set( rpm_pkg_name "rmr-devel" ) +else() + set( deb_pkg_name "rmr" ) + set( rpm_pkg_name "rmr" ) +endif() + +set( pkg_label "rmr${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${sys_name}" ) +set( rpm_pkg_label "${rpm_pkg_name}${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${rpm_sys_name}" ) +set( deb_pkg_label "${deb_pkg_name}${spoiled_str}_${major_version}.${minor_version}.${patch_level}_${deb_sys_name}" ) +message( "+++ pkg name: ${deb_pkg_label}.deb" ) + +#set( out_yml /tmp/build_output.yml ) # we will record package names (we record only untainted names) +find_program( rpm NAMES rpmbuild ) # rpm package gen requires this to be installed + +set( gen_rpm 0 ) +if( "${rpm}" MATCHES "rpm-NOTFOUND" ) # cannot build rpm + set( pkg_list "DEB" ) + message( "### make package will generate only deb package; cannot find support to generate rpm packages" ) +else() + message( "+++ pkg name: ${rpm_pkg_label}.rpm" ) # debugging if we think we can gen rpm too + set( pkg_list "DEB;RPM" ) + set( gen_rpm 1 ) + message( "+++ make package will generate both deb and rpm packages" ) +endif() # ---------------- setup nano/nng things --------------------------------------- if( NOT SKIP_EXTERNALS ) @@ -89,9 +171,6 @@ if( NOT SKIP_EXTERNALS ) WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} ) - execute_process( COMMAND git submodule update --init -- ext/nanomsg - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} - ) if( NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/ext/nng/CMakeLists.txt ) message( FATAL_ERROR "cannot find nng in our git source as a submodule: Giving up" ) # this will abort which seems wrong, but tdam. endif() @@ -107,48 +186,37 @@ if( NOT SKIP_EXTERNALS ) TEST_COMMAND "" STEP_TARGETS build ) - ExternalProject_Add( - nanomsg - SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ext/nanomsg" - BUILD_COMMAND "make" - UPDATE_COMMAND "" - CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_CURRENT_BINARY_DIR}" - TEST_COMMAND "" - STEP_TARGETS build - ) # it seems impossible to install everything that lands in {bin}/lib, so we need to # hard code (shudder) some things. Even worse, we have to make exceptions for # builds on apple (osx) since their naming convention wandered off the path. set( nng_major 1 ) set( nng_minor 1.0 ) - set( nano_major 5 ) - set( nano_minor 1.0 ) set( so ${CMAKE_SHARED_LIBRARY_SUFFIX} ) # cmake variables are impossibly long :( if( NOT APPLE ) # probably breaks in windows, but idc set( nng_so_suffix ${so} ) set( nng_so_suffix_m ${so}.${nng_major} ) set( nng_so_suffix_mm ${so}.${nng_major}.${nng_minor} ) - - set( nano_so_suffix ${so} ) - set( nano_so_suffix_m ${so}.${nano_major} ) - set( nano_so_suffix_mm ${so}.${nano_major}.${nano_minor} ) else() # of course apple puts versions before the suffix :( set( nng_so_suffix ${so} ) # so has a lead dot, so NOT needed set( nng_so_suffix_m ".${nng_major}${so}" ) # these need leading dots set( nng_so_suffix_mm ".${nng_major}.${nng_minor}${so}" ) - - set( nano_so_suffix ${so} ) - set( nano_so_suffix_m ".${nano_major}${so}" ) - set( nano_so_suffix_mm ".${nano_major}.${nano_minor}${so}" ) endif() - message( "+++ installing nano/nng with: ${nano_major}.${nano_minor} | ${nng_major}.${nng_minor}" ) + message( "+++ building with nng: ${nng_major}.${nng_minor}" ) else() + if( PACK_EXTERNALS ) + # This makes some stand-alone unit testing possible for bindings and transport layer testing; + # it is not meant for production packages. + # + unset( SKIP_EXTERNALS CACHE ) # must remove so as not to trap user into a never ending failure + unset( PACK_EXTERNALS CACHE ) + message( FATAL_ERROR "ERROR: PACK_EXTERNALS can be set only if SKIP_EXTERNALS is unset (=0, or not supplied on command line)" ) + endif() set( need_ext 0 ) endif() -unset( SKIP_EXTERNALS CACHE ) # prevent it from being applied next build unless specifically set on comd line + # this gets us round a chicken/egg problem. include files don't exist until make is run @@ -162,110 +230,147 @@ include_directories( "${CMAKE_CURRENT_BINARY_DIR}/include" ) # Compiler flags # set( CMAKE_POSITION_INDEPENDENT_CODE ON ) -set( CMAKE_CXX_FLAGS "-g -Wall " ) +#set( CMAKE_C_FLAGS "-g -Wall " ) +#set( CMAKE_C_FLAGS "-g " ) +if( GPROF ) # if set, we'll set profiling flag on compiles + message( "+++ profiling is on" ) + set( CMAKE_C_FLAGS "-pg " ) +else() + message( "+++ profiling is off" ) + set( CMAKE_C_FLAGS "-g " ) +endif() +unset( GPROF CACHE ) # we don't want this to persist # Include modules -add_subdirectory( src/common ) -add_subdirectory( src/nanomsg ) -add_subdirectory( src/nng ) +add_subdirectory( src/rmr/common ) +add_subdirectory( src/rmr/nng ) +add_subdirectory( src/rmr/si ) add_subdirectory( doc ) # this will auto skip if {X}fm is not available -# shared and static libraries built from the same object files -# Nanomsg based library (librmr ) -# library is built by pulling object files from nano and common subdirs +# shared and static libraries are built from the same object files. +# librmr_nng is a combination of common and nng specific rmr functions. # -add_library( rmr_shared SHARED "$;$" ) -add_library( rmr_static STATIC "$;$" ) - -# both libraries to be named with librmr prefix and given version numbers with sym links -set_target_properties( rmr_shared - PROPERTIES - OUTPUT_NAME "rmr" - SOVERSION ${major_version} - VERSION ${major_version}.${minor_version}.${patch_level} ) -set_target_properties( rmr_static - PROPERTIES - OUTPUT_NAME "rmr" - SOVERSION ${major_version} +add_library( rmr_nng_shared SHARED "$;$" ) +set_target_properties( rmr_nng_shared + PROPERTIES + OUTPUT_NAME "rmr_nng" + SOVERSION ${major_version} + VERSION ${major_version}.${minor_version}.${patch_level} ) + +# we only build/export the static archive (.a) if generating a dev package +if( DEV_PKG ) + add_library( rmr_nng_static STATIC "$;$" ) + set_target_properties( rmr_nng_static + PROPERTIES + OUTPUT_NAME "rmr_nng" + SOVERSION ${major_version} VERSION ${major_version}.${minor_version}.${patch_level} ) +endif() +add_library( rmr_si_shared SHARED "$;$" ) +set_target_properties( rmr_si_shared + PROPERTIES + OUTPUT_NAME "rmr_si" + SOVERSION ${major_version} + VERSION ${major_version}.${minor_version}.${patch_level} ) -# NNG based library (librmr_nng ) -# library is built by pulling objects from nng and common subdirs. +# even if not generating a development package we still need to generate the .a so that health check +# can link against it to avoid RPM install issues. # -add_library( rmr_nng_shared SHARED "$;$" ) -add_library( rmr_nng_static STATIC "$;$" ) - - +add_library( rmr_si_static STATIC "$;$" ) +set_target_properties( rmr_si_static + PROPERTIES + OUTPUT_NAME "rmr_si" + SOVERSION ${major_version} + VERSION ${major_version}.${minor_version}.${patch_level} ) # if externals need to be built, then we must force them to be built first by depending on them if( need_ext ) - add_dependencies( rmr_static;rmr_shared nanomsg ) - add_dependencies( rmr_nng_shared;rmr_nng_static ext_nng ) + if( DEV_PKG ) + add_dependencies( rmr_nng_shared;rmr_nng_static ext_nng ) + else() + add_dependencies( rmr_nng_shared ext_nng ) + endif() endif() +# ------------- testing ------------------------------------------------------- +enable_testing() +add_test( + NAME drive_unit_tests + COMMAND bash ../test/unit_test.ksh -q + WORKING_DIRECTORY ../test +) + +# cmake seems unable to start test/app_test/run_all.ksh, so we have to lump +# a dummy script in ./test that does the obvious thing. +add_test( + NAME drive_app + COMMAND bash ./run_app_tests LD_LIBRARY_PATH=${install_root}/lib C_INCLUDE_PATH=${install_root}/include + WORKING_DIRECTORY ../test +) -# both libraries to be named with librmr_nng prefix and given version numbers with sym links -set_target_properties( rmr_nng_shared - PROPERTIES - OUTPUT_NAME "rmr_nng" - SOVERSION ${major_version} - VERSION ${major_version}.${minor_version}.${patch_level} ) -set_target_properties( rmr_nng_static - PROPERTIES - OUTPUT_NAME "rmr_nng" - SOVERSION ${major_version} - VERSION ${major_version}.${minor_version}.${patch_level} ) +# --- support binaries that depend on the libs identified above --------------- +add_subdirectory( src/support ) + +# ------------- packaging ----------------------------------------------------- # if( APPLE ) message( "### apple hack: forcing hard coded library paths for nng/nano dynamic libraries" ) - target_link_libraries( rmr_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnanomsg${nano_so_suffix} ) target_link_libraries( rmr_nng_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnng${nng_so_suffix} ) endif() -# Define directories where package should drop things when installed -# In CMake speak archive == *.a library == *.so, so both are needed -# Headers from the common directory are forced to install by the local CM file in common. At -# the moment, there are no header files specific to either nano or nng, so to the public -# header directive is moot, but needed if some day there is one. +# Define what should be installed, and where they should go. For dev package we install +# only the RMr headers, man pages and archive (.a) files. The run-time package gets just +# the library (.so) files and nothing more. # -#install( TARGETS rmr_nng_shared;rmr_nng_static;rmr_shared;rmr_static;rmr_nng_shared_mm EXPORT LibraryConfig -install( TARGETS rmr_nng_shared;rmr_nng_static;rmr_shared;rmr_static EXPORT LibraryConfig - ARCHIVE DESTINATION ${install_lib} - LIBRARY DESTINATION ${install_lib} - PUBLIC_HEADER DESTINATION ${install_inc} +if( DEV_PKG ) + set( target_list "rmr_nng_static;rmr_si_static" ) +else() + set( target_list "rmr_nng_shared;rmr_si_shared" ) +endif() + +install( TARGETS ${target_list} EXPORT LibraryConfig + LIBRARY DESTINATION ${install_lib} + ARCHIVE DESTINATION ${install_lib} + PUBLIC_HEADER DESTINATION ${install_inc} ) +unset( DEV_PKG CACHE ) # prevent from being a hidden setting if user redoes things -# install any nano/nng libraries in to the deb as well, but ONLY if we created them. -# (sure would be nice if FILEs allowed for globbing; sadlyy it does not. +# install any nano/nng libraries in to the deb as well, but ONLY if asked for on the 'cmake ..' command +# (sure would be nice if FILEs allowed for globbing; sadlyy it does not.) # -if( need_ext ) - message( "including nano and nng libraries in the deb" ) +if( PACK_EXTERNALS ) + message( "+++ including nano and nng libraries in the deb" ) install( FILES - ${CMAKE_CURRENT_BINARY_DIR}/${BUILD_LIB}/libnanomsg${nano_so_suffix} - ${CMAKE_CURRENT_BINARY_DIR}/${BUILD_LIB}/libnanomsg${nano_so_suffix_m} - ${CMAKE_CURRENT_BINARY_DIR}/${BUILD_LIB}/libnanomsg${nano_so_suffix_mm} - ${CMAKE_CURRENT_BINARY_DIR}/${BUILD_LIB}/libnng${nng_so_suffix} - ${CMAKE_CURRENT_BINARY_DIR}/${BUILD_LIB}/libnng${nng_so_suffix_m} - ${CMAKE_CURRENT_BINARY_DIR}/${BUILD_LIB}/libnng${nng_so_suffix_mm} + ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix} + ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_m} + ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_mm} DESTINATION ${install_lib} ) endif() +unset( SKIP_EXTERNALS CACHE ) # prevent these from being applied next build unless specifically set on comd line +unset( PACK_EXTERNALS CACHE ) IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" ) include( InstallRequiredSystemLibraries ) + set( CPACK_DEBIAN_PACKAGE_NAME ${deb_pkg_name} ) + set( CPACK_RPM_PACKAGE_NAME ${rpm_pkg_name} ) + + # auto dependency checking makes the RPM install fail, see NOTES + set( CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION="/usr/local /usr/local/bin /usr/local/lib" ) + set( CPACK_set_DESTDIR "on" ) set( CPACK_PACKAGING_INSTALL_PREFIX "${install_root}" ) - set( CPACK_GENERATOR "DEB" ) + set( CPACK_GENERATOR "${pkg_list}" ) set( CPACK_PACKAGE_DESCRIPTION "Thin library for RIC xAPP messaging routed based on message type." ) set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "RIC message routing library" ) @@ -274,15 +379,16 @@ IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" ) set( CPACK_PACKAGE_VERSION_MAJOR "${major_version}" ) set( CPACK_PACKAGE_VERSION_MINOR "${minor_version}" ) set( CPACK_PACKAGE_VERSION_PATCH "${patch_level}" ) - set( CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}_${major_version}.${minor_version}.${CPACK_PACKAGE_VERSION_PATCH}${spoiled_str}" ) - set( CPACK_SOURCE_PACKAGE_FILE_NAME "vric${CMAKE_PROJECT_NAME}_${major_version}.${minor_version}.${CPACK_PACKAGE_VERSION_PATCH}" ) + set( CPACK_PACKAGE "${pkg_label}" ) # generic name for old versions of cpack + set( CPACK_DEBIAN_FILE_NAME "${deb_pkg_label}.deb" ) + set( CPACK_RPM_FILE_NAME "${rpm_pkg_label}.rpm" ) - # we build and ship the libraries, so there is NO dependency - #set( CPACK_DEBIAN_PACKAGE_DEPENDS "nanomsg ( >= 1.1.4 ), nng ( >= 1.1.1 )" ) + # there is not an NNG package, so we cannot define a dependency set( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" ) set( CPACK_DEBIAN_PACKAGE_SECTION "ric" ) set( CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} ) + set( CPACK_RPM_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} ) # this seems ingnored if included #set( CPACK_COMPONENTS_ALL Libraries ApplicationData )