blob: b4122d7c1b75fb6df6aceca7904fcb171bdff54f [file] [log] [blame]
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -04001#
2#==================================================================================
E. Scott Daniels29d87162019-06-12 13:48:25 -04003# Copyright (c) 2019 Nokia
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -04004# 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
E. Scott Danielsf6f4f122019-06-18 16:02:17 -040020# This CMake definition supports several -D command line options:
21#
22# -DDEV_PKG=1 Development package configuration
23# -DBUILD_DOC=1 Man pages generated
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -040024# -DIGNORE_LIBDIR=1 Installation of rmr libries is into /usr/local/lib and ignores
25# value in CMAKE_INSTALL_LIBDIR.
26# system preferred (typically /usr/local/lib64).
E. Scott Danielsf6f4f122019-06-18 16:02:17 -040027# -DPRESERVE_PTYPE=1 Do not change the processor type when naming deb packages
28# -DPACK_EXTERNALS=1 Include external libraries used to build in the run-time package
E. Scott Danielse30fc3a2019-07-16 12:03:45 -040029# (This makes some stand-alone unit testing of bindings possible, it
30# is not meant to be used for production package generation.)
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -040031# -DSKIP_EXTERNALS=1 Do not use NNG submodule when building; uee installed packages
E. Scott Danielsf6f4f122019-06-18 16:02:17 -040032# -DMAN_PREFIX=<path> Supply a path where man pages are installed (default: /usr/share/man)
33
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -040034project( rmr LANGUAGES C )
35cmake_minimum_required( VERSION 3.5 )
36
E. Scott Danielsd7109572019-04-18 14:01:16 +000037set( major_version "1" ) # should be automatically populated from git tag later, but until CI process sets a tag we use this
E. Scott Danielsf23c7752019-09-17 13:58:33 -040038set( minor_version "7" )
E. Scott Daniels4ac73e32019-08-13 11:35:04 -040039set( patch_level "0" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -040040
41set( install_root "${CMAKE_INSTALL_PREFIX}" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -040042set( install_inc "include/rmr" )
43if( MAN_PREFIX )
44 set( install_man ${MAN_PREFIX} ) # is there a cmake var for this -- can't find one
45else()
46 set( install_man "/usr/share/man" ) # this needs to be fixed so it's not hard coded
47endif()
48
49# Must use GNUInstallDirs to install libraries into correct
50# locations on all platforms.
51include( GNUInstallDirs )
52
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -040053# nng installs using LIBDIR as established by the gnu include; it varies from system
54# to system, and we don't trust that it is always set, so we default to lib if it is missing.
E. Scott Danielsa9435332019-05-09 14:39:19 +000055#
56if( NOT CMAKE_INSTALL_LIBDIR )
57 set( CMAKE_INSTALL_LIBDIR "lib" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -040058endif()
59
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -040060if( IGNORE_LIBDIR ) # if set, then force to lib otherwise use "system preference"
61 set( install_lib "lib" )
62else()
63 set( install_lib "${CMAKE_INSTALL_LIBDIR}" )
64endif()
65unset(IGNORE_LIBDIR CACHE ) # we don't want this to persist
66message( "+++ RMR library install target directory: ${install_lib}" )
67
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000068# ---------------- extract some things from git ------------------------------
69
70# commit id for the version string
E. Scott Daniels29d87162019-06-12 13:48:25 -040071execute_process(
72 COMMAND bash -c "git rev-parse --short HEAD|awk '{printf\"%s\", $0}'"
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -040073 OUTPUT_VARIABLE git_id
74)
75
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000076# version information for library names and version string
E. Scott Daniels29d87162019-06-12 13:48:25 -040077execute_process(
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000078 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' "
79 OUTPUT_VARIABLE mmp_version_str
80 ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE
81)
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -040082message( "+++ mmp version from tag: '${mmp_version_str}'" )
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000083
84# extra indicator to show that the build was based on modified file(s) and not the true commit
E. Scott Daniels29d87162019-06-12 13:48:25 -040085# (no hope of reproducing the exact library for debugging). Used only for the internal version
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000086# string.
E. Scott Daniels29d87162019-06-12 13:48:25 -040087execute_process(
88 COMMAND bash -c "git diff --shortstat|awk -v fmt=%s -v r=-rotten '{ s=r } END { printf( fmt, s ) }'"
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000089 OUTPUT_VARIABLE spoiled_str
90)
91
E. Scott Danielsd7109572019-04-18 14:01:16 +000092# uncomment these lines once CI starts adding a tag on merge
93#set( mmp_version ${mmp_version_str} )
94#list( GET mmp_version 0 major_version )
95#list( GET mmp_version 1 minor_version )
96#list( GET mmp_version 2 patch_level )
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000097
E. Scott Daniels68c5cf12019-04-12 15:14:40 +000098
99# define constants used in the version string
E. Scott Daniels29d87162019-06-12 13:48:25 -0400100add_definitions(
101 -DGIT_ID=${git_id}
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400102 -DMAJOR_VER=${major_version}
103 -DMINOR_VER=${minor_version}
E. Scott Danielsd4f18ba2019-06-17 15:08:17 -0400104 -DPATCH_VER=${patch_level}
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400105)
106
E. Scott Daniels29d87162019-06-12 13:48:25 -0400107# ---------------- suss out pkg gen tools so we don't fail generating packages that the system cannot support --------------
108
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400109# deb packages use underbars, and package manager(s) seem to flip the *_64 processor type
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400110# to the old (non-standard) amd64 string, so we do it here for consistency. Set -DPRESERVE_PTYPE=1
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400111# to prevent the flip. RPM packages will always be given the system generated processor type string.
112#
113if( ${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64" )
114 if( NOT PRESERVE_PTYPE )
115 set( deb_sys_name "amd64" )
116 else()
117 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
118 endif()
119else()
120 set( deb_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
121endif()
122unset( PRESERVE_PTYPE CACHE ) # we don't want this to persist
123
124set( rpm_sys_name ${CMAKE_SYSTEM_PROCESSOR} )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400125
126if( DEV_PKG )
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400127 set( deb_pkg_name "rmr-dev" )
128 set( rpm_pkg_name "rmr-devel" )
E. Scott Danielsd4f18ba2019-06-17 15:08:17 -0400129else()
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400130 set( deb_pkg_name "rmr" )
131 set( rpm_pkg_name "rmr" )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400132endif()
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400133
134set( pkg_label "rmr${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${sys_name}" )
135set( rpm_pkg_label "${rpm_pkg_name}${spoiled_str}-${major_version}.${minor_version}.${patch_level}-${rpm_sys_name}" )
136set( deb_pkg_label "${deb_pkg_name}${spoiled_str}_${major_version}.${minor_version}.${patch_level}_${deb_sys_name}" )
137message( "+++ pkg name: ${deb_pkg_label}.deb" )
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400138
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400139#set( out_yml /tmp/build_output.yml ) # we will record package names (we record only untainted names)
E. Scott Daniels29d87162019-06-12 13:48:25 -0400140find_program( rpm NAMES rpmbuild ) # rpm package gen requires this to be installed
141
142set( gen_rpm 0 )
143if( "${rpm}" MATCHES "rpm-NOTFOUND" ) # cannot build rpm
144 set( pkg_list "DEB" )
145 message( "### make package will generate only deb package; cannot find support to generate rpm packages" )
146else()
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400147 message( "+++ pkg name: ${rpm_pkg_label}.rpm" ) # debugging if we think we can gen rpm too
E. Scott Daniels29d87162019-06-12 13:48:25 -0400148 set( pkg_list "DEB;RPM" )
149 set( gen_rpm 1 )
150 message( "+++ make package will generate both deb and rpm packages" )
151endif()
152
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400153# ---------------- setup nano/nng things ---------------------------------------
154if( NOT SKIP_EXTERNALS )
155 set( need_ext 1 ) # we force dependences on these for right build order
156 execute_process( COMMAND git submodule update --init -- ext/nng
157 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
158 )
159
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400160 if( NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/ext/nng/CMakeLists.txt )
161 message( FATAL_ERROR "cannot find nng in our git source as a submodule: Giving up" ) # this will abort which seems wrong, but tdam.
162 endif()
163
164 include( ExternalProject )
165 ExternalProject_Add(
166 ext_nng
167 SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ext/nng"
168 CMAKE_ARGS "-DBUILD_SHARED_LIBS=1"
169 CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${CMAKE_CURRENT_BINARY_DIR}"
170 BUILD_COMMAND "make"
171 UPDATE_COMMAND ""
172 TEST_COMMAND ""
173 STEP_TARGETS build
174 )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400175
176 # it seems impossible to install everything that lands in {bin}/lib, so we need to
177 # hard code (shudder) some things. Even worse, we have to make exceptions for
178 # builds on apple (osx) since their naming convention wandered off the path.
179 set( nng_major 1 )
180 set( nng_minor 1.0 )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400181 set( so ${CMAKE_SHARED_LIBRARY_SUFFIX} ) # cmake variables are impossibly long :(
182 if( NOT APPLE ) # probably breaks in windows, but idc
183 set( nng_so_suffix ${so} )
184 set( nng_so_suffix_m ${so}.${nng_major} )
185 set( nng_so_suffix_mm ${so}.${nng_major}.${nng_minor} )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400186 else()
187 # of course apple puts versions before the suffix :(
188 set( nng_so_suffix ${so} ) # so has a lead dot, so NOT needed
189 set( nng_so_suffix_m ".${nng_major}${so}" ) # these need leading dots
190 set( nng_so_suffix_mm ".${nng_major}.${nng_minor}${so}" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400191 endif()
192
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400193 message( "+++ building with nng: ${nng_major}.${nng_minor}" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400194else()
E. Scott Daniels29d87162019-06-12 13:48:25 -0400195 if( PACK_EXTERNALS )
E. Scott Danielse30fc3a2019-07-16 12:03:45 -0400196 # This makes some stand-alone unit testing possible for bindings and transport layer testing;
197 # it is not meant for production packages.
198 #
E. Scott Daniels29d87162019-06-12 13:48:25 -0400199 unset( SKIP_EXTERNALS CACHE ) # must remove so as not to trap user into a never ending failure
200 unset( PACK_EXTERNALS CACHE )
201 message( FATAL_ERROR "ERROR: PACK_EXTERNALS can be set only if SKIP_EXTERNALS is unset (=0, or not supplied on command line)" )
202 endif()
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400203 set( need_ext 0 )
204endif()
E. Scott Daniels29d87162019-06-12 13:48:25 -0400205
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400206
207
208# this gets us round a chicken/egg problem. include files don't exist until make is run
209# but Cmake insists on having these exist when we add them to include directories to
210# enable rmr code to find them after we build them.
211#
212execute_process( COMMAND "mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/include/nng" )
213include_directories( "${CMAKE_CURRENT_BINARY_DIR}/include" )
214
215
216# Compiler flags
217#
218set( CMAKE_POSITION_INDEPENDENT_CODE ON )
219set( CMAKE_CXX_FLAGS "-g -Wall " )
220
221# Include modules
E. Scott Daniels68c1ab22019-05-17 17:50:59 +0000222add_subdirectory( src/rmr/common )
E. Scott Daniels68c1ab22019-05-17 17:50:59 +0000223add_subdirectory( src/rmr/nng )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400224add_subdirectory( doc ) # this will auto skip if {X}fm is not available
225
226
E. Scott Daniels29d87162019-06-12 13:48:25 -0400227# shared and static libraries are built from the same object files.
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400228# librmr_nng is a combination of common and nng specific rmr functions.
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400229#
E. Scott Daniels68c5cf12019-04-12 15:14:40 +0000230
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400231add_library( rmr_nng_shared SHARED "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400232set_target_properties( rmr_nng_shared
233 PROPERTIES
234 OUTPUT_NAME "rmr_nng"
235 SOVERSION ${major_version}
236 VERSION ${major_version}.${minor_version}.${patch_level} )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400237
E. Scott Daniels29d87162019-06-12 13:48:25 -0400238# we only build/export the static archive (.a) if generating a dev package
239if( DEV_PKG )
240 add_library( rmr_nng_static STATIC "$<TARGET_OBJECTS:nng_objects>;$<TARGET_OBJECTS:common_objects>" )
241 set_target_properties( rmr_nng_static
242 PROPERTIES
243 OUTPUT_NAME "rmr_nng"
244 SOVERSION ${major_version}
245 VERSION ${major_version}.${minor_version}.${patch_level} )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400246endif()
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400247
248# if externals need to be built, then we must force them to be built first by depending on them
249if( need_ext )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400250 if( DEV_PKG )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400251 add_dependencies( rmr_nng_shared;rmr_nng_static ext_nng )
252 else()
E. Scott Daniels29d87162019-06-12 13:48:25 -0400253 add_dependencies( rmr_nng_shared ext_nng )
254 endif()
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400255endif()
256
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400257#
258if( APPLE )
259 message( "### apple hack: forcing hard coded library paths for nng/nano dynamic libraries" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400260 target_link_libraries( rmr_nng_shared ${CMAKE_CURRENT_BINARY_DIR}/lib/libnng${nng_so_suffix} )
261endif()
262
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400263# Define what should be installed, and where they should go. For dev package we install
264# only the RMr headers, man pages and archive (.a) files. The run-time package gets just
265# the library (.so) files and nothing more.
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400266#
E. Scott Daniels29d87162019-06-12 13:48:25 -0400267if( DEV_PKG )
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400268 set( target_list "rmr_nng_static" )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400269else()
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400270 set( target_list "rmr_nng_shared" )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400271endif()
272
273install( TARGETS ${target_list} EXPORT LibraryConfig
274 LIBRARY DESTINATION ${install_lib}
275 ARCHIVE DESTINATION ${install_lib}
276 PUBLIC_HEADER DESTINATION ${install_inc}
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400277)
278
279
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400280unset( DEV_PKG CACHE ) # prevent from being a hidden setting if user redoes things
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400281
E. Scott Daniels29d87162019-06-12 13:48:25 -0400282# install any nano/nng libraries in to the deb as well, but ONLY if asked for on the 'cmake ..' command
283# (sure would be nice if FILEs allowed for globbing; sadlyy it does not.)
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400284#
E. Scott Daniels29d87162019-06-12 13:48:25 -0400285if( PACK_EXTERNALS )
E. Scott Daniels257323c2019-06-14 12:30:21 -0400286 message( "+++ including nano and nng libraries in the deb" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400287 install( FILES
E. Scott Danielsa9435332019-05-09 14:39:19 +0000288 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix}
289 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_m}
290 ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}/libnng${nng_so_suffix_mm}
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400291
292 DESTINATION ${install_lib}
293 )
294endif()
295
E. Scott Daniels257323c2019-06-14 12:30:21 -0400296unset( SKIP_EXTERNALS CACHE ) # prevent these from being applied next build unless specifically set on comd line
297unset( PACK_EXTERNALS CACHE )
298
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400299IF( EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake" )
300 include( InstallRequiredSystemLibraries )
301
E. Scott Daniels78da4c92019-06-19 10:59:18 -0400302 set( CPACK_DEBIAN_PACKAGE_NAME ${deb_pkg_name} )
303 set( CPACK_RPM_PACKAGE_NAME ${rpm_pkg_name} )
304
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400305 set( CPACK_set_DESTDIR "on" )
306 set( CPACK_PACKAGING_INSTALL_PREFIX "${install_root}" )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400307 set( CPACK_GENERATOR "${pkg_list}" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400308
309 set( CPACK_PACKAGE_DESCRIPTION "Thin library for RIC xAPP messaging routed based on message type." )
310 set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "RIC message routing library" )
311 set( CPACK_PACKAGE_VENDOR "None" )
312 set( CPACK_PACKAGE_CONTACT "None" )
313 set( CPACK_PACKAGE_VERSION_MAJOR "${major_version}" )
314 set( CPACK_PACKAGE_VERSION_MINOR "${minor_version}" )
315 set( CPACK_PACKAGE_VERSION_PATCH "${patch_level}" )
E. Scott Danielsf6f4f122019-06-18 16:02:17 -0400316 set( CPACK_PACKAGE "${pkg_label}" ) # generic name for old versions of cpack
E. Scott Danielsd4f18ba2019-06-17 15:08:17 -0400317 set( CPACK_DEBIAN_FILE_NAME "${deb_pkg_label}.deb" )
318 set( CPACK_RPM_FILE_NAME "${rpm_pkg_label}.rpm" )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400319
E. Scott Danielsb0ba22e2019-08-06 13:26:12 -0400320 # there is not an NNG package, so we cannot define a dependency
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400321
322 set( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" )
323 set( CPACK_DEBIAN_PACKAGE_SECTION "ric" )
324 set( CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
E. Scott Daniels29d87162019-06-12 13:48:25 -0400325 set( CPACK_RPM_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR} )
Ashwin Sridharanfd9cc7a2019-04-03 16:47:02 -0400326
327 # this seems ingnored if included
328 #set( CPACK_COMPONENTS_ALL Libraries ApplicationData )
329
330 INCLUDE( CPack )
331ENDIF()