1 #==================================================================================
2 # Copyright (c) 2019 Nokia
3 # Copyright (c) 2018-2019 AT&T Intellectual Property.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 #==================================================================================
19 # This CMake definition supports several -D command line options:
21 # -DDEBUG=n Enable debugging level n
22 # -DDEV_PKG=1 Development package configuration
23 # -DBUILD_DOC=1 Man pages generated
24 # -DPRESERVE_PTYPE=1 Do not change the processor type when naming deb packages
25 # -DGPROF=1 Enable profiling compile time flags
26 # -DMAN_PREFIX=<path> Supply a path where man pages are installed (default: /usr/share/man)
29 cmake_minimum_required( VERSION 3.5 )
31 set( major_version "2" ) # should be automatically populated from git tag later, but until CI process sets a tag we use this
32 set( minor_version "1" )
33 set( patch_level "0" )
35 set( install_root "${CMAKE_INSTALL_PREFIX}" )
36 set( install_inc "include/ricxfcpp" )
38 set( install_man ${MAN_PREFIX} ) # is there a cmake var for this -- can't find one
40 set( install_man "/usr/share/man" ) # this needs to be fixed so it's not hard coded
43 # Must use GNUInstallDirs to install libraries into correct
44 # locations on all platforms.
45 include( GNUInstallDirs )
47 # externals may install using LIBDIR as established by the gnu include; it varies from system
48 # to system, and we don't trust that it is always set, so we default to lib if it is missing.
50 if( NOT CMAKE_INSTALL_LIBDIR )
51 set( CMAKE_INSTALL_LIBDIR "lib" )
54 set( install_lib "${CMAKE_INSTALL_LIBDIR}" )
55 message( "+++ ricxfcpp library install target directory: ${install_lib}" )
57 # ---------------- extract some things from git ------------------------------
59 # commit id for the version string
61 COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'"
62 OUTPUT_VARIABLE git_id
65 # version information for library names and version string
67 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' "
68 OUTPUT_VARIABLE mmp_version_str
69 ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE
71 message( "+++ mmp version from tag: '${mmp_version_str}'" )
73 # extra indicator to show that the build was based on modified file(s) and not the true commit
74 # (no hope of reproducing the exact library for debugging). Used only for the internal version
77 COMMAND bash -c "git diff --shortstat|awk -v fmt=%s -v r=-rotten '{ s=r } END { printf( fmt, s ) }'"
78 OUTPUT_VARIABLE spoiled_str
81 # uncomment these lines once CI starts adding a tag on merge
82 #set( mmp_version ${mmp_version_str} )
83 #list( GET mmp_version 0 major_version )
84 #list( GET mmp_version 1 minor_version )
85 #list( GET mmp_version 2 patch_level )
87 if( DEBUG ) # if set, we'll set debugging on in the compile
88 set( debugging ${DEBUG} )
89 message( "+++ debugging is being set to ${DEBUG}" )
92 message( "+++ debugging is set to off" )
94 unset( DEBUG CACHE ) # we don't want this to persist
97 # define constants used in the version string, debugging, etc.
100 -DMAJOR_VER=${major_version}
101 -DMINOR_VER=${minor_version}
102 -DPATCH_VER=${patch_level}
106 # ---------------- suss out pkg gen tools so we don't fail generating packages that the system cannot support --------------
108 # deb packages use underbars, and package manager(s) seem to flip the *_64 processor type
109 # to the old (non-standard) amd64 string, so we do it here for consistency. Set -DPRESERVE_PTYPE=1
110 # to prevent the flip. RPM packages will always be given the system generated processor type string.
112 if( ${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64" )
113 if( NOT PRESERVE_PTYPE )
114 set( deb_sys_name "amd64" )
116 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
119 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
121 unset( PRESERVE_PTYPE CACHE ) # we don't want this to persist
123 set( rpm_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
126 set( deb_pkg_name "ricxfcpp-dev" )
127 set( rpm_pkg_name "ricxfcpp-devel" )
129 set( deb_pkg_name "ricxfcpp" )
130 set( rpm_pkg_name "ricxfcpp" )
133 set( pkg_label "ricxfcpp${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${sys_name}" )
134 set( rpm_pkg_label "${rpm_pkg_name}${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${rpm_sys_name}" )
135 set( deb_pkg_label "${deb_pkg_name}${spoiled_str}_${major_version}.${minor_version}.${patch_level}_${deb_sys_name}" )
136 message( "+++ pkg name: ${deb_pkg_label}.deb" )
139 find_program( rpm NAMES rpmbuild ) # rpm package gen requires this to be installed
140 if( "${rpm}" MATCHES "rpm-NOTFOUND" ) # cannot build rpm
141 set( pkg_list "DEB" )
142 message( "### make package will generate only deb package; cannot find support to generate rpm packages" )
144 message( "+++ pkg name: ${rpm_pkg_label}.rpm" ) # debugging if we think we can gen rpm too
145 set( pkg_list "DEB;RPM" )
147 message( "+++ make package will generate both deb and rpm packages" )
152 # bleeding cmake names are short novels; and when lines cannot be split they're a pain
153 set ( srcd "${CMAKE_CURRENT_SOURCE_DIR}" )
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 code to find them after we build them.
159 include_directories( "${srcd}/src/messaging;${srcd}/src/json;${srcd}/src/alarm;${srcd}/src/metrics;${srcd}/ext/jsmn" )
163 set( CMAKE_POSITION_INDEPENDENT_CODE ON )
164 set( CMAKE_C_FLAGS "-g " )
165 set( CMAKE_CPP_FLAGS "-g " )
166 set( CMAKE_CXX_FLAGS "-g " )
167 if( GPROF ) # if set, we'll set profiling flag on compiles
168 message( "+++ profiling is on" )
169 set( CMAKE_C_FLAGS "-pg " )
170 set( CMAKE_CPP_FLAGS "-pg " )
172 message( "+++ profiling is off" )
174 unset( GPROF CACHE ) # we don't want this to persist
177 # --------------------- external building --------------------------------------------------------
178 execute_process( COMMAND git submodule update --init -- ext/jsmn
179 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
183 # --------------------- framework building --------------------------------------------------------
185 add_subdirectory( src/json )
186 add_subdirectory( src/messaging )
187 add_subdirectory( src/xapp )
188 add_subdirectory( src/alarm )
189 add_subdirectory( src/metrics )
190 #add_subdirectory( doc ) # this will auto skip if {X}fm is not available
192 # shared and static libraries are built from the same object files.
194 add_library( ricxfcpp_shared SHARED
195 "$<TARGET_OBJECTS:message_objects>;$<TARGET_OBJECTS:json_objects>;$<TARGET_OBJECTS:alarm_objects>;$<TARGET_OBJECTS:metrics_objects>;$<TARGET_OBJECTS:xapp_objects>"
197 set_target_properties( ricxfcpp_shared
199 OUTPUT_NAME "ricxfcpp"
200 SOVERSION ${major_version}
201 VERSION ${major_version}.${minor_version}.${patch_level}
203 #target_include_directories( ricxfcpp_shared PUBLIC "src/alarm" "src/metrics" "src/messenger" "src/xapp" )
205 # we only build/export the static archive (.a) if generating a dev package
207 add_library( ricxfcpp_static STATIC
208 "$<TARGET_OBJECTS:message_objects>;$<TARGET_OBJECTS:json_objects>;$<TARGET_OBJECTS:alarm_objects>;$<TARGET_OBJECTS:metrics_objects>;$<TARGET_OBJECTS:xapp_objects>"
210 set_target_properties( ricxfcpp_static
212 OUTPUT_NAME "ricxfcpp"
213 SOVERSION ${major_version}
214 VERSION ${major_version}.${minor_version}.${patch_level}
216 # target_include_directories( ricxfcpp_static PUBLIC "src/alarm" "src/metrics" "src/messenger" "src/xapp" )
219 # -------- unit testing -------------------------------------------------------
222 NAME drive_unit_tests
223 COMMAND bash ../test/unit_test.sh -q CMBUILD=${CMAKE_CURRENT_BINARY_DIR}
224 WORKING_DIRECTORY ../test
228 # ------------- packaging -----------------------------------------------------
230 # Define what should be installed, and where they should go. For dev package we install
231 # only the RMr headers, man pages and archive (.a) files. The run-time package gets just
232 # the library (.so) files and nothing more.
235 set( target_list "ricxfcpp_static" )
237 set( target_list "ricxfcpp_shared" )
240 install( TARGETS ${target_list} EXPORT LibraryConfig
241 LIBRARY DESTINATION ${install_lib}
242 ARCHIVE DESTINATION ${install_lib}
243 PUBLIC_HEADER DESTINATION ${install_inc}
246 unset( DEV_PKG CACHE ) # prevent from being a hidden setting if user redoes things
248 IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" )
249 include( InstallRequiredSystemLibraries )
251 set( CPACK_DEBIAN_PACKAGE_NAME ${deb_pkg_name} )
252 set( CPACK_RPM_PACKAGE_NAME ${rpm_pkg_name} )
254 set( CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/usr/local;/usr/local/bin;/usr/local/include;/usr/local/share;/usr/local/lib" )
256 set( CPACK_set_DESTDIR "on" )
257 set( CPACK_PACKAGING_INSTALL_PREFIX "${install_root}" )
258 set( CPACK_GENERATOR "${pkg_list}" )
260 set( CPACK_PACKAGE_DESCRIPTION "C++ framework for RIC xAPPs based on RMR." )
261 set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "RIC xAPP C++ framework library" )
262 set( CPACK_PACKAGE_VENDOR "None" )
263 set( CPACK_PACKAGE_CONTACT "None" )
264 set( CPACK_PACKAGE_VERSION_MAJOR "${major_version}" )
265 set( CPACK_PACKAGE_VERSION_MINOR "${minor_version}" )
266 set( CPACK_PACKAGE_VERSION_PATCH "${patch_level}" )
267 set( CPACK_PACKAGE "${pkg_label}" ) # generic name for old versions of cpack
268 set( CPACK_DEBIAN_FILE_NAME "${deb_pkg_label}.deb" )
269 set( CPACK_RPM_FILE_NAME "${rpm_pkg_label}.rpm" )
271 # Future: define dependencies on RMR and other libs
273 set( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" )
274 set( CPACK_DEBIAN_PACKAGE_SECTION "ric" )
275 set( CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
276 set( CPACK_RPM_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
278 # this seems ingnored if included
279 #set( CPACK_COMPONENTS_ALL Libraries ApplicationData )