blob: fbadf9f610eb89ab4bef1674e5dd18399a227841 [file] [log] [blame]
akmhoque298385a2014-02-13 14:13:09 -06001# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
Yingdi Yu40cd1c32014-04-17 15:02:17 -07002"""
Davide Pesavento5a1d77a2024-03-13 19:24:11 -04003Copyright (c) 2014-2024, The University of Memphis,
Vince Lehmanc2e51f62015-01-20 15:03:11 -06004 Regents of the University of California,
5 Arizona Board of Regents.
Yingdi Yu40cd1c32014-04-17 15:02:17 -07006
7This file is part of NLSR (Named-data Link State Routing).
8See AUTHORS.md for complete list of NLSR authors and contributors.
9
10NLSR is free software: you can redistribute it and/or modify it under the terms
11of the GNU General Public License as published by the Free Software Foundation,
12either version 3 of the License, or (at your option) any later version.
13
14NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
16PURPOSE. See the GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License along with
19NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
20"""
21
Davide Pesavento5849ee72023-11-12 20:00:21 -050022import os
23import subprocess
Davide Pesaventof75bfda2019-11-10 18:34:13 -050024from waflib import Context, Logs, Utils
Davide Pesaventof75bfda2019-11-10 18:34:13 -050025
awlanee8c3f162024-08-12 12:21:23 -040026VERSION = '24.08'
Davide Pesaventofa54ee92023-02-20 04:16:51 -050027APPNAME = 'nlsr'
28GIT_TAG_PREFIX = 'NLSR-'
akmhoque298385a2014-02-13 14:13:09 -060029
akmhoque298385a2014-02-13 14:13:09 -060030def options(opt):
Yingdi Yu40cd1c32014-04-17 15:02:17 -070031 opt.load(['compiler_cxx', 'gnu_dirs'])
Davide Pesavento7ae8b082021-10-12 21:45:47 -040032 opt.load(['default-compiler-flags',
33 'coverage', 'sanitizers', 'boost',
Davide Pesavento5a1d77a2024-03-13 19:24:11 -040034 'doxygen', 'sphinx'],
Davide Pesaventoe5569912019-01-29 19:39:06 -050035 tooldir=['.waf-tools'])
akmhoque298385a2014-02-13 14:13:09 -060036
Davide Pesaventof75bfda2019-11-10 18:34:13 -050037 optgrp = opt.add_option_group('NLSR Options')
Varun Patil7d2d6892022-10-14 12:50:30 -070038
39 optgrp.add_option('--with-chronosync', dest='with_chronosync', action='store_true', default=False,
Davide Pesavento7ae8b082021-10-12 21:45:47 -040040 help='Build with ChronoSync support')
Varun Patil7d2d6892022-10-14 12:50:30 -070041 optgrp.add_option('--without-chronosync', dest='with_chronosync', action='store_false', default=False,
42 help='Build without ChronoSync support')
43
44 optgrp.add_option('--with-psync', dest='with_psync', action='store_true', default=True,
45 help='Build with PSync support')
46 optgrp.add_option('--without-psync', dest='with_psync', action='store_false', default=True,
47 help='Build without PSync support')
48
49 optgrp.add_option('--with-svs', dest='with_svs', action='store_true', default=False,
50 help='Build with State Vector Sync support')
51 optgrp.add_option('--without-svs', dest='with_svs', action='store_false', default=False,
52 help='Build without State Vector Sync support')
akmhoque05d5fcf2014-04-15 14:58:45 -050053
Davide Pesaventofcef0582022-12-06 15:00:02 -050054 optgrp.add_option('--with-tests', action='store_true', default=False,
55 help='Build unit tests')
56
akmhoque298385a2014-02-13 14:13:09 -060057def configure(conf):
Vince Lehmanb722b102014-08-24 16:33:49 -050058 conf.load(['compiler_cxx', 'gnu_dirs',
Davide Pesavento6ebfd7c2017-08-26 17:52:54 -040059 'default-compiler-flags', 'boost',
Davide Pesavento5a1d77a2024-03-13 19:24:11 -040060 'doxygen', 'sphinx'])
akmhoque298385a2014-02-13 14:13:09 -060061
Davide Pesaventof75bfda2019-11-10 18:34:13 -050062 conf.env.WITH_TESTS = conf.options.with_tests
Alexander Afanasyevfb2adee2015-03-30 10:56:55 -070063
Davide Pesaventoede59632022-08-26 20:35:44 -040064 conf.find_program('dot', mandatory=False)
65
66 # Prefer pkgconf if it's installed, because it gives more correct results
67 # on Fedora/CentOS/RHEL/etc. See https://bugzilla.redhat.com/show_bug.cgi?id=1953348
68 # Store the result in env.PKGCONFIG, which is the variable used inside check_cfg()
69 conf.find_program(['pkgconf', 'pkg-config'], var='PKGCONFIG')
Davide Pesavento7ae8b082021-10-12 21:45:47 -040070
Davide Pesaventod1f1df82022-03-12 16:40:37 -050071 pkg_config_path = os.environ.get('PKG_CONFIG_PATH', f'{conf.env.LIBDIR}/pkgconfig')
awlanee8c3f162024-08-12 12:21:23 -040072 conf.check_cfg(package='libndn-cxx', args=['libndn-cxx >= 0.9.0', '--cflags', '--libs'],
Davide Pesaventod1f1df82022-03-12 16:40:37 -050073 uselib_store='NDN_CXX', pkg_config_path=pkg_config_path)
akmhoque85d88332014-02-17 21:11:21 -060074
Davide Pesavento5849ee72023-11-12 20:00:21 -050075 conf.check_boost(lib='filesystem', mt=True)
76 if conf.env.BOOST_VERSION_NUMBER < 107100:
77 conf.fatal('The minimum supported version of Boost is 1.71.0.\n'
Davide Pesavento7ae8b082021-10-12 21:45:47 -040078 'Please upgrade your distribution or manually install a newer version of Boost.\n'
79 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost')
akmhoque05d5fcf2014-04-15 14:58:45 -050080
Davide Pesavento5849ee72023-11-12 20:00:21 -050081 if conf.env.WITH_TESTS:
82 conf.check_boost(lib='unit_test_framework', mt=True, uselib_store='BOOST_TESTS')
83
Ashlesh Gawande30d96e42021-03-21 19:15:33 -070084 if conf.options.with_chronosync:
awlanee8c3f162024-08-12 12:21:23 -040085 conf.check_cfg(package='ChronoSync', args=['ChronoSync >= 0.5.6', '--cflags', '--libs'],
Ashlesh Gawande30d96e42021-03-21 19:15:33 -070086 uselib_store='CHRONOSYNC', pkg_config_path=pkg_config_path)
akmhoque05d5fcf2014-04-15 14:58:45 -050087
Varun Patil7d2d6892022-10-14 12:50:30 -070088 if conf.options.with_psync:
awlanee8c3f162024-08-12 12:21:23 -040089 conf.check_cfg(package='PSync', args=['PSync >= 0.5.0', '--cflags', '--libs'],
Varun Patil7d2d6892022-10-14 12:50:30 -070090 uselib_store='PSYNC', pkg_config_path=pkg_config_path)
91
92 if conf.options.with_svs:
93 conf.check_cfg(package='libndn-svs', args=['libndn-svs >= 0.1.0', '--cflags', '--libs'],
94 uselib_store='SVS', pkg_config_path=pkg_config_path)
95
96 if not any((conf.options.with_chronosync, conf.options.with_psync, conf.options.with_svs)):
Davide Pesaventob6adfe12024-07-05 13:03:15 -040097 conf.fatal('Cannot compile without any Sync protocol.\n'
Varun Patil7d2d6892022-10-14 12:50:30 -070098 'Specify at least one of --with-psync or --with-svs or --with-chronosync')
Ashlesh Gawande32ec3fd2018-07-18 13:42:32 -050099
Davide Pesaventob6adfe12024-07-05 13:03:15 -0400100 if conf.env.WITH_TESTS and not conf.options.with_psync:
101 conf.fatal('--with-tests requires --with-psync')
102
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500103 conf.check_compiler_flags()
104
Davide Pesaventoe5569912019-01-29 19:39:06 -0500105 # Loading "late" to prevent tests from being compiled with profiling flags
Yingdi Yu40cd1c32014-04-17 15:02:17 -0700106 conf.load('coverage')
Davide Pesaventoc58cc7f2017-08-08 16:51:28 -0500107 conf.load('sanitizers')
108
Davide Pesaventof75bfda2019-11-10 18:34:13 -0500109 conf.define_cond('WITH_TESTS', conf.env.WITH_TESTS)
Davide Pesavento5849ee72023-11-12 20:00:21 -0500110 conf.define('DEFAULT_CONFIG_FILE', f'{conf.env.SYSCONFDIR}/ndn/nlsr.conf')
Davide Pesaventof75bfda2019-11-10 18:34:13 -0500111 # The config header will contain all defines that were added using conf.define()
112 # or conf.define_cond(). Everything that was added directly to conf.env.DEFINES
113 # will not appear in the config header, but will instead be passed directly to the
114 # compiler on the command line.
Yingdi Yu40cd1c32014-04-17 15:02:17 -0700115 conf.write_config_header('config.hpp')
akmhoque05d5fcf2014-04-15 14:58:45 -0500116
Vince Lehmanb722b102014-08-24 16:33:49 -0500117def build(bld):
118 version(bld)
119
Davide Pesaventoe5569912019-01-29 19:39:06 -0500120 bld(features='subst',
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500121 name='version.hpp',
Vince Lehmanb722b102014-08-24 16:33:49 -0500122 source='src/version.hpp.in',
123 target='src/version.hpp',
Davide Pesavento5849ee72023-11-12 20:00:21 -0500124 install_path=None,
Vince Lehmanb722b102014-08-24 16:33:49 -0500125 VERSION_STRING=VERSION_BASE,
awlanee8c3f162024-08-12 12:21:23 -0400126 VERSION_BUILD=VERSION)
Vince Lehmanb722b102014-08-24 16:33:49 -0500127
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500128 bld.objects(
Yingdi Yu40cd1c32014-04-17 15:02:17 -0700129 target='nlsr-objects',
Davide Pesavento5849ee72023-11-12 20:00:21 -0500130 source=bld.path.ant_glob('src/**/*.cpp', excl=['src/main.cpp']),
131 use='BOOST NDN_CXX CHRONOSYNC PSYNC SVS',
Yingdi Yu40cd1c32014-04-17 15:02:17 -0700132 includes='. src',
Davide Pesaventoc58cc7f2017-08-08 16:51:28 -0500133 export_includes='. src')
akmhoque298385a2014-02-13 14:13:09 -0600134
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500135 bld.program(
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500136 name='nlsr',
Davide Pesavento5849ee72023-11-12 20:00:21 -0500137 target='bin/nlsr',
Yingdi Yu40cd1c32014-04-17 15:02:17 -0700138 source='src/main.cpp',
Davide Pesaventoc58cc7f2017-08-08 16:51:28 -0500139 use='nlsr-objects')
akmhoque298385a2014-02-13 14:13:09 -0600140
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500141 bld.program(
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500142 name='nlsrc',
Davide Pesavento5849ee72023-11-12 20:00:21 -0500143 target='bin/nlsrc',
Vince Lehmanc439d662015-04-27 10:56:00 -0500144 source='tools/nlsrc.cpp',
Davide Pesaventoe5569912019-01-29 19:39:06 -0500145 use='nlsr-objects')
Vince Lehmanc439d662015-04-27 10:56:00 -0500146
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500147 if bld.env.WITH_TESTS:
Yingdi Yu40cd1c32014-04-17 15:02:17 -0700148 bld.recurse('tests')
Vince Lehmanb722b102014-08-24 16:33:49 -0500149
Davide Pesavento5849ee72023-11-12 20:00:21 -0500150 # Install sample config
Davide Pesavento0da3eab2019-01-31 01:10:00 -0500151 bld.install_as('${SYSCONFDIR}/ndn/nlsr.conf.sample', 'nlsr.conf')
152
153 if Utils.unversioned_sys_platform() == 'linux':
154 bld(features='subst',
Davide Pesavento5849ee72023-11-12 20:00:21 -0500155 name='systemd-units',
Davide Pesavento0da3eab2019-01-31 01:10:00 -0500156 source='systemd/nlsr.service.in',
157 target='systemd/nlsr.service')
158
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500159 if bld.env.SPHINX_BUILD:
160 bld(features='sphinx',
161 name='manpages',
162 builder='man',
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500163 config='docs/conf.py',
Davide Pesavento0da3eab2019-01-31 01:10:00 -0500164 outdir='docs/manpages',
Davide Pesaventof75bfda2019-11-10 18:34:13 -0500165 source=bld.path.ant_glob('docs/manpages/*.rst'),
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500166 install_path='${MANDIR}',
Davide Pesaventof75bfda2019-11-10 18:34:13 -0500167 version=VERSION_BASE,
168 release=VERSION)
Vince Lehmanb722b102014-08-24 16:33:49 -0500169
170def docs(bld):
171 from waflib import Options
172 Options.commands = ['doxygen', 'sphinx'] + Options.commands
173
174def doxygen(bld):
175 version(bld)
176
177 if not bld.env.DOXYGEN:
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500178 bld.fatal('Cannot build documentation ("doxygen" not found in PATH)')
Vince Lehmanb722b102014-08-24 16:33:49 -0500179
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500180 bld(features='subst',
181 name='doxygen.conf',
182 source=['docs/doxygen.conf.in',
183 'docs/named_data_theme/named_data_footer-with-analytics.html.in'],
184 target=['docs/doxygen.conf',
185 'docs/named_data_theme/named_data_footer-with-analytics.html'],
186 VERSION=VERSION,
Davide Pesavento7ae8b082021-10-12 21:45:47 -0400187 HAVE_DOT='YES' if bld.env.DOT else 'NO',
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500188 HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \
189 if os.getenv('GOOGLE_ANALYTICS', None) \
190 else '../docs/named_data_theme/named_data_footer.html',
191 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ''))
192
193 bld(features='doxygen',
194 doxyfile='docs/doxygen.conf',
195 use='doxygen.conf')
Vince Lehmanb722b102014-08-24 16:33:49 -0500196
197def sphinx(bld):
198 version(bld)
199
200 if not bld.env.SPHINX_BUILD:
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500201 bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)')
202
203 bld(features='sphinx',
204 config='docs/conf.py',
205 outdir='docs',
206 source=bld.path.ant_glob('docs/**/*.rst'),
Davide Pesaventof75bfda2019-11-10 18:34:13 -0500207 version=VERSION_BASE,
208 release=VERSION)
Vince Lehmanb722b102014-08-24 16:33:49 -0500209
210def version(ctx):
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500211 # don't execute more than once
Vince Lehmanb722b102014-08-24 16:33:49 -0500212 if getattr(Context.g_module, 'VERSION_BASE', None):
213 return
214
215 Context.g_module.VERSION_BASE = Context.g_module.VERSION
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500216 Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.')
Vince Lehmanb722b102014-08-24 16:33:49 -0500217
Alexander Afanasyev67758b12018-03-06 18:36:44 -0500218 # first, try to get a version string from git
Davide Pesavento50213142024-04-22 03:44:05 -0400219 version_from_git = ''
Vince Lehmanb722b102014-08-24 16:33:49 -0500220 try:
Davide Pesavento50213142024-04-22 03:44:05 -0400221 cmd = ['git', 'describe', '--abbrev=8', '--always', '--match', f'{GIT_TAG_PREFIX}*']
222 version_from_git = subprocess.run(cmd, capture_output=True, check=True, text=True).stdout.strip()
223 if version_from_git:
224 if GIT_TAG_PREFIX and version_from_git.startswith(GIT_TAG_PREFIX):
225 Context.g_module.VERSION = version_from_git[len(GIT_TAG_PREFIX):]
226 elif not GIT_TAG_PREFIX and ('.' in version_from_git or '-' in version_from_git):
227 Context.g_module.VERSION = version_from_git
Vince Lehmanb722b102014-08-24 16:33:49 -0500228 else:
Davide Pesavento50213142024-04-22 03:44:05 -0400229 # no tags matched (or we are in a shallow clone)
230 Context.g_module.VERSION = f'{VERSION_BASE}+git.{version_from_git}'
Davide Pesavento5849ee72023-11-12 20:00:21 -0500231 except (OSError, subprocess.SubprocessError):
Vince Lehmanb722b102014-08-24 16:33:49 -0500232 pass
233
Davide Pesavento50213142024-04-22 03:44:05 -0400234 # fallback to the VERSION.info file, if it exists and is not empty
235 version_from_file = ''
236 version_file = ctx.path.find_node('VERSION.info')
237 if version_file is not None:
Vince Lehmanb722b102014-08-24 16:33:49 -0500238 try:
Davide Pesavento50213142024-04-22 03:44:05 -0400239 version_from_file = version_file.read().strip()
240 except OSError as e:
241 Logs.warn(f'{e.filename} exists but is not readable ({e.strerror})')
242 if version_from_file and not version_from_git:
243 Context.g_module.VERSION = version_from_file
244 return
Vince Lehmanb722b102014-08-24 16:33:49 -0500245
Davide Pesavento50213142024-04-22 03:44:05 -0400246 # update VERSION.info if necessary
247 if version_from_file == Context.g_module.VERSION:
248 # already up-to-date
249 return
250 if version_file is None:
251 version_file = ctx.path.make_node('VERSION.info')
Vince Lehmanb722b102014-08-24 16:33:49 -0500252 try:
Davide Pesavento50213142024-04-22 03:44:05 -0400253 version_file.write(Context.g_module.VERSION)
254 except OSError as e:
255 Logs.warn(f'{e.filename} is not writable ({e.strerror})')
Vince Lehmanb722b102014-08-24 16:33:49 -0500256
257def dist(ctx):
Davide Pesaventofa54ee92023-02-20 04:16:51 -0500258 ctx.algo = 'tar.xz'
Vince Lehmanb722b102014-08-24 16:33:49 -0500259 version(ctx)
260
261def distcheck(ctx):
Davide Pesaventofa54ee92023-02-20 04:16:51 -0500262 ctx.algo = 'tar.xz'
Vince Lehmanb722b102014-08-24 16:33:49 -0500263 version(ctx)