2 #==================================================================================
3 # Copyright (c) 2019 Nokia
4 # Copyright (c) 2018-2019 AT&T Intellectual Property.
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
10 # http://www.apache.org/licenses/LICENSE-2.0
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 #==================================================================================
20 # This CMake definition supports several -D command line options:
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)
36 # See ci/build_all for an example of how to build and test
38 project( rmr LANGUAGES C )
39 cmake_minimum_required( VERSION 3.5 )
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 "6" )
43 set( patch_level "3" )
45 set( install_root "${CMAKE_INSTALL_PREFIX}" )
46 set( install_inc "include/rmr" )
48 set( install_man ${MAN_PREFIX} ) # is there a cmake var for this -- can't find one
50 set( install_man "/usr/share/man" ) # this needs to be fixed so it's not hard coded
53 # Must use GNUInstallDirs to install libraries into correct
54 # locations on all platforms.
55 include( GNUInstallDirs )
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.
60 if( NOT CMAKE_INSTALL_LIBDIR )
61 set( CMAKE_INSTALL_LIBDIR "lib" )
64 if( IGNORE_LIBDIR ) # if set, then force to lib otherwise use "system preference"
65 set( install_lib "lib" )
67 set( install_lib "${CMAKE_INSTALL_LIBDIR}" )
69 unset(IGNORE_LIBDIR CACHE ) # we don't want this to persist
70 message( "+++ RMR library install target directory: ${install_lib}" )
72 # ---------------- extract some things from git ------------------------------
74 # commit id for the version string
76 COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'"
77 OUTPUT_VARIABLE git_id
80 # version information for library names and version string
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
86 message( "+++ mmp version from tag: '${mmp_version_str}'" )
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
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
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 )
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}" )
107 message( "+++ debugging is set to off" )
109 unset( DEBUG CACHE ) # we don't want this to persist
112 # define constants used in the version string, debugging, etc.
115 -DMAJOR_VER=${major_version}
116 -DMINOR_VER=${minor_version}
117 -DPATCH_VER=${patch_level}
121 # ---------------- suss out pkg gen tools so we don't fail generating packages that the system cannot support --------------
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.
127 if( ${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64" )
128 if( NOT PRESERVE_PTYPE )
129 set( deb_sys_name "amd64" )
131 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
134 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
136 unset( PRESERVE_PTYPE CACHE ) # we don't want this to persist
138 set( rpm_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
141 set( deb_pkg_name "rmr-dev" )
142 set( rpm_pkg_name "rmr-devel" )
144 set( deb_pkg_name "rmr" )
145 set( rpm_pkg_name "rmr" )
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" )
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
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" )
161 message( "+++ pkg name: ${rpm_pkg_label}.rpm" ) # debugging if we think we can gen rpm too
162 set( pkg_list "DEB;RPM" )
164 message( "+++ make package will generate both deb and rpm packages" )
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}
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.
178 include( ExternalProject )
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}"
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.
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} )
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}" )
207 message( "+++ building with nng: ${nng_major}.${nng_minor}" )
210 # This makes some stand-alone unit testing possible for bindings and transport layer testing;
211 # it is not meant for production packages.
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)" )
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.
226 execute_process( COMMAND "mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/include/nng" )
227 include_directories( "${CMAKE_CURRENT_BINARY_DIR}/include" )
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 " )
239 message( "+++ profiling is off" )
240 set( CMAKE_C_FLAGS "-g " )
242 unset( GPROF CACHE ) # we don't want this to persist
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
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.
255 add_library( rmr_nng_shared SHARED "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
256 set_target_properties( rmr_nng_shared
258 OUTPUT_NAME "rmr_nng"
259 SOVERSION ${major_version}
260 VERSION ${major_version}.${minor_version}.${patch_level} )
262 # we only build/export the static archive (.a) if generating a dev package
264 add_library( rmr_nng_static STATIC "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
265 set_target_properties( rmr_nng_static
267 OUTPUT_NAME "rmr_nng"
268 SOVERSION ${major_version}
269 VERSION ${major_version}.${minor_version}.${patch_level} )
272 add_library( rmr_si_shared SHARED "$<TARGET_OBJECTS:rmr_si_objects>;$<TARGET_OBJECTS:common_objects>" )
273 set_target_properties( rmr_si_shared
276 SOVERSION ${major_version}
277 VERSION ${major_version}.${minor_version}.${patch_level} )
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.
282 add_library( rmr_si_static STATIC "$<TARGET_OBJECTS:rmr_si_objects>;$<TARGET_OBJECTS:common_objects>" )
283 set_target_properties( rmr_si_static
286 SOVERSION ${major_version}
287 VERSION ${major_version}.${minor_version}.${patch_level} )
289 # if externals need to be built, then we must force them to be built first by depending on them
292 add_dependencies( rmr_nng_shared;rmr_nng_static ext_nng )
294 add_dependencies( rmr_nng_shared ext_nng )
298 # ------------- testing -------------------------------------------------------
301 NAME drive_unit_tests
302 COMMAND bash ../test/unit_test.ksh -q
303 WORKING_DIRECTORY ../test
306 # cmake seems unable to start test/app_test/run_all.ksh, so we have to lump
307 # a dummy script in ./test that does the obvious thing.
310 COMMAND bash ./run_app_tests LD_LIBRARY_PATH=${install_root}/lib C_INCLUDE_PATH=${install_root}/include
311 WORKING_DIRECTORY ../test
315 # --- support binaries that depend on the libs identified above ---------------
316 add_subdirectory( src/support )
318 # ------------- packaging -----------------------------------------------------
322 message( "### apple hack: forcing hard coded library paths for nng/nano dynamic libraries" )
323 target_link_libraries( rmr_nng_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnng${nng_so_suffix} )
326 # Define what should be installed, and where they should go. For dev package we install
327 # only the RMr headers, man pages and archive (.a) files. The run-time package gets just
328 # the library (.so) files and nothing more.
331 set( target_list "rmr_nng_static;rmr_si_static" )
333 set( target_list "rmr_nng_shared;rmr_si_shared" )
336 install( TARGETS ${target_list} EXPORT LibraryConfig
337 LIBRARY DESTINATION ${install_lib}
338 ARCHIVE DESTINATION ${install_lib}
339 PUBLIC_HEADER DESTINATION ${install_inc}
343 unset( DEV_PKG CACHE ) # prevent from being a hidden setting if user redoes things
345 # install any nano/nng libraries in to the deb as well, but ONLY if asked for on the 'cmake ..' command
346 # (sure would be nice if FILEs allowed for globbing; sadlyy it does not.)
349 message( "+++ including nano and nng libraries in the deb" )
351 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix}
352 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_m}
353 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_mm}
355 DESTINATION ${install_lib}
359 unset( SKIP_EXTERNALS CACHE ) # prevent these from being applied next build unless specifically set on comd line
360 unset( PACK_EXTERNALS CACHE )
362 IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" )
363 include( InstallRequiredSystemLibraries )
365 set( CPACK_DEBIAN_PACKAGE_NAME ${deb_pkg_name} )
366 set( CPACK_RPM_PACKAGE_NAME ${rpm_pkg_name} )
368 # auto dependency checking makes the RPM install fail, see NOTES
369 set( CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION="/usr/local /usr/local/bin /usr/local/lib" )
371 set( CPACK_set_DESTDIR "on" )
372 set( CPACK_PACKAGING_INSTALL_PREFIX "${install_root}" )
373 set( CPACK_GENERATOR "${pkg_list}" )
375 set( CPACK_PACKAGE_DESCRIPTION "Thin library for RIC xAPP messaging routed based on message type." )
376 set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "RIC message routing library" )
377 set( CPACK_PACKAGE_VENDOR "None" )
378 set( CPACK_PACKAGE_CONTACT "None" )
379 set( CPACK_PACKAGE_VERSION_MAJOR "${major_version}" )
380 set( CPACK_PACKAGE_VERSION_MINOR "${minor_version}" )
381 set( CPACK_PACKAGE_VERSION_PATCH "${patch_level}" )
382 set( CPACK_PACKAGE "${pkg_label}" ) # generic name for old versions of cpack
383 set( CPACK_DEBIAN_FILE_NAME "${deb_pkg_label}.deb" )
384 set( CPACK_RPM_FILE_NAME "${rpm_pkg_label}.rpm" )
386 # there is not an NNG package, so we cannot define a dependency
388 set( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" )
389 set( CPACK_DEBIAN_PACKAGE_SECTION "ric" )
390 set( CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
391 set( CPACK_RPM_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
393 # this seems ingnored if included
394 #set( CPACK_COMPONENTS_ALL Libraries ApplicationData )