1 # -*- mode: python; python-indent-offset: 4; indent-tabs-mode: nil -*-
3 # This script includes generic build options:
4 # release/debug, target os, target arch, cross toolchain, build environment etc
9 project_version = '1.2.1'
11 # Map of host os and allowed target os (host: allowed target os)
13 'linux': ['linux', 'android', 'arduino', 'yocto', 'tizen', 'tizenrt'],
14 'windows': ['windows', 'android', 'arduino'],
15 'darwin': ['darwin', 'ios', 'android', 'arduino'],
16 'msys_nt' :['msys_nt'],
19 # Map of os and allowed archs (os: allowed archs)
21 'linux': ['x86', 'x86_64', 'arm', 'arm-v7a', 'armeabi-v7a', 'arm64'],
22 'tizen': ['x86', 'x86_64', 'arm', 'arm-v7a', 'armeabi-v7a', 'arm64'],
23 'android': ['x86', 'x86_64', 'armeabi', 'armeabi-v7a', 'armeabi-v7a-hard', 'arm64-v8a'],
24 'windows': ['x86', 'amd64', 'arm'],
25 'msys_nt':['x86', 'x86_64'],
26 'darwin': ['i386', 'x86_64'],
27 'ios': ['i386', 'x86_64', 'armv7', 'armv7s', 'arm64'],
28 'arduino': ['avr', 'arm'],
29 'yocto': ['i586', 'i686', 'x86_64', 'arm', 'aarch64', 'powerpc', 'powerpc64', 'mips', 'mipsel'],
30 'tizenrt': ['armv7-r', 'armv7-m'],
33 host = platform.system().lower()
35 # the host string contains version of windows. 6.3, 6.4, 10.0 which is 8.0, 8.1, and 10 respectively.
36 # Let's canonicalize the msys_nt-XX.X system name by stripping version off.
40 if not host_target_map.has_key(host):
41 print "\nError: Current system (%s) isn't supported\n" % host
44 ######################################################################
45 # Get build options (the optins from command line)
46 ######################################################################
47 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
49 if target_os not in host_target_map[host]:
50 print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
53 if target_os == 'android':
56 default_arch = platform.machine()
58 if default_arch not in os_arch_map[target_os]:
59 default_arch = os_arch_map[target_os][0].lower()
61 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
63 # True if binary needs to be installed on board. (Might need root permissions)
64 # set to 'no', 'false' or 0 for only compilation
65 require_upload = ARGUMENTS.get('UPLOAD', False)
67 # Get the device name. This name can be used as network display name wherever possible
68 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
70 default_with_upstream_libcoap = 0
72 if ARGUMENTS.get('TEST'):
73 logging_default = False
76 if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
78 logging_default = (release_mode == False)
80 # targets that do not support the DTLS build (SECURED=1 build option)
81 targets_without_dtls_support = ['arduino'];
82 if ARGUMENTS.get('SECURED') == '1' and target_os in targets_without_dtls_support:
83 print "\nError: DTLS not supported on target os: %s MUST build with SECURED=0\n" % (target_os)
86 ######################################################################
87 # Common build options (release, target os, target arch)
88 ######################################################################
89 targets_disallow_multitransport = ['arduino']
91 help_vars = Variables()
92 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
93 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
94 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
97 help_vars.Add(BoolVariable('WITH_RA', 'Build with Remote Access module', False))
98 help_vars.Add(BoolVariable('WITH_TCP', 'Build with TCP adapter', False))
99 help_vars.Add(BoolVariable('DISABLE_TCP_SERVER', 'Disable TCP server', False))
100 help_vars.Add(BoolVariable('WITH_PROXY', 'Build with CoAP-HTTP Proxy', False))
101 help_vars.Add(ListVariable('WITH_MQ', 'Build with MQ publisher/broker', 'OFF', ['OFF', 'SUB', 'PUB', 'BROKER']))
102 help_vars.Add(BoolVariable('WITH_CLOUD', 'Build including AccountManager class and Cloud Client sample', False))
103 help_vars.Add(ListVariable('RD_MODE', 'Resource Directory build mode', 'CLIENT', ['CLIENT', 'SERVER']))
104 help_vars.Add(BoolVariable('DISABLE_PRESENCE', 'Disable Presence Feature', False))
106 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
108 help_vars.Add(BoolVariable('WITH_RA_IBB', 'Build with Remote Access module(workssys)', False))
109 help_vars.Add(BoolVariable('WITH_ASAN', 'Build with Address Sanitizer support', False))
112 if target_os in targets_disallow_multitransport:
113 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP', 'NFC']))
115 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'NFC']))
117 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
118 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
119 help_vars.Add(EnumVariable('WITH_MBEDTLS_STATIC_LIB', 'Build mbedTLS library as static library', '0', allowed_values=('0', '1')))
120 help_vars.Add(EnumVariable('MULTIPLE_OWNER', 'Enable multiple owner', '0', allowed_values=('0', '1')))
121 help_vars.Add(EnumVariable('EXC_PROV_SUPPORT', 'Except OCPMAPI library(libocpmapi.so)', '0', allowed_values=('0', '1')))
122 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
123 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
124 help_vars.Add(EnumVariable('LOG_LEVEL', 'Enable stack logging level', 'DEBUG', allowed_values=('DEBUG', 'INFO', 'ERROR', 'WARNING', 'FATAL')))
125 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
126 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
127 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
128 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
129 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
130 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
131 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
132 help_vars.Add(EnumVariable('WITH_UPSTREAM_LIBCOAP', 'Use latest stable version of LibCoAP downloaded from github', default_with_upstream_libcoap, allowed_values=('0','1')))
133 help_vars.Add(EnumVariable('BLE_CUSTOM_ADV', 'Build with CUSTOM Advertisement', 'False', allowed_values=('True', 'False')))
134 help_vars.Add(EnumVariable('BLE_DIVISION', 'BLE Build with division code', 'OFF', allowed_values=('OFF', 'MCD', 'VD')))
135 help_vars.Add(EnumVariable('BLE_TIZEN_30', 'Build with tizen 3.0 BLE api', 'False', allowed_values=('True', 'False')))
136 help_vars.Add(EnumVariable('TIZEN_4', 'Build with tizen 4.0 api', 'False', allowed_values=('True', 'False')))
137 help_vars.Add(PathVariable('TIZENRT_OS_DIR', 'Absolute Path to TizenRT OS directory', None, PathVariable.PathAccept))
138 help_vars.Add(EnumVariable('PLATFORM_TLS', 'Use platform tls instead of local mbedtls', '0', allowed_values=('0', '1')))
139 help_vars.Add(EnumVariable('OIC_SUPPORT_TIZEN_TRACE', 'Tizen Trace(T-trace) api availability', 'False', allowed_values=('True', 'False')))
140 AddOption('--prefix',
146 help='installation prefix')
148 ######################################################################
149 # Platform(build target) specific options: SDK/NDK & toolchain
150 ######################################################################
151 targets_support_cc = ['linux', 'arduino', 'tizen', 'tizenrt']
153 if target_os in targets_support_cc:
154 # Set cross compile toolchain
155 help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
156 help_vars.Add(PathVariable('TC_PATH',
157 'Toolchain path (Generally only be required for cross-compiling)',
158 os.environ.get('TC_PATH')))
160 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
161 env = Environment(variables = help_vars,
162 tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
165 env = Environment(variables = help_vars, tools = ['default', 'textfile'],
166 TARGET_ARCH = target_arch, TARGET_OS = target_os,
167 PREFIX = GetOption('prefix'),
168 LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR') #for 64bit build
170 Help(help_vars.GenerateHelpText(env))
173 ************************************ Warning **********************************
174 * Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
175 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
176 * cause inexplicable errors. *
177 *******************************************************************************
179 if env.get('VERBOSE') == False:
180 env['CCCOMSTR'] = "Compiling $TARGET"
181 env['SHCCCOMSTR'] = "Compiling $TARGET"
182 env['CXXCOMSTR'] = "Compiling $TARGET"
183 env['SHCXXCOMSTR'] = "Compiling $TARGET"
184 env['LINKCOMSTR'] = "Linking $TARGET"
185 env['SHLINKCOMSTR'] = "Linking $TARGET"
186 env['ARCOMSTR'] = "Archiving $TARGET"
187 env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
189 if target_os in targets_support_cc:
190 prefix = env.get('TC_PREFIX')
191 tc_path = env.get('TC_PATH')
193 env.Replace(CC = prefix + env.get('CC', 'gcc'))
194 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
195 env.Replace(AR = prefix + env.get('AR', 'ar'))
196 env.Replace(AS = prefix + env.get('AS', 'as'))
197 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
200 env.PrependENVPath('PATH', tc_path)
201 sys_root = os.path.abspath(tc_path + '/../')
202 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
203 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
205 if target_os == 'tizenrt':
206 env.PrependENVPath('PATH', os.environ['PATH'])
208 if prefix or tc_path:
211 # If cross-compiling, honor environment settings for toolchain to avoid picking up native tools
212 if os.environ.get('PKG_CONFIG') != None:
213 env["ENV"]["PKG_CONFIG"] = os.environ.get("PKG_CONFIG")
214 if os.environ.get('PKG_CONFIG_PATH') != None:
215 env["ENV"]["PKG_CONFIG_PATH"] = os.environ.get("PKG_CONFIG_PATH")
216 if os.environ.get('PKG_CONFIG_SYSROOT_DIR') != None:
217 env["ENV"]["PKG_CONFIG_SYSROOT_DIR"] = os.environ.get("PKG_CONFIG_SYSROOT_DIR")
219 # Ensure scons be able to change its working directory
220 env.SConscriptChdir(1)
222 # Set the source directory and build directory
223 # Source directory: 'dir'
224 # Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
226 # You can get the directory as following:
228 # env.get('BUILD_DIR')
230 def __set_dir(env, dir):
231 if not os.path.exists(dir + '/SConstruct'):
233 *************************************** Error *********************************
234 * The directory(%s) seems isn't a source code directory, no SConstruct file is
236 *******************************************************************************
240 if env.get('RELEASE'):
241 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
243 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
244 env.VariantDir(build_dir, dir, duplicate=0)
246 env.Replace(BUILD_DIR = build_dir)
247 env.Replace(SRC_DIR = dir)
249 def __src_to_obj(env, src, home = ''):
250 obj = env.get('BUILD_DIR') + src.replace(home, '')
251 if env.get('OBJSUFFIX'):
252 obj += env.get('OBJSUFFIX')
253 return env.Object(obj, src)
255 def __install(ienv, targets, name):
256 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
258 env.AppendUnique(TS = [name])
260 def __installlib(ienv, targets, name):
261 user_prefix = env.get('PREFIX')
263 user_lib = env.get('LIB_INSTALL_DIR')
265 i_n = ienv.Install(user_lib, targets)
267 i_n = ienv.Install(user_prefix + '/lib', targets)
268 ienv.Alias("install", i_n)
270 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
271 ienv.Alias("install", i_n)
273 def __installbin(ienv, targets, name):
274 user_prefix = env.get('PREFIX')
276 i_n = ienv.Install(user_prefix + '/bin', targets)
277 ienv.Alias("install", i_n)
279 def __installheader(ienv, targets, dir, name):
280 user_prefix = env.get('PREFIX')
282 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
284 i_n = ienv.Install(os.path.join(env.get('BUILD_DIR'), 'include', dir), targets)
285 ienv.Alias("install", i_n)
287 def __installpcfile(ienv, targets, name):
288 user_prefix = env.get('PREFIX')
290 user_lib = env.get('LIB_INSTALL_DIR')
292 i_n = ienv.Install(user_lib + '/pkgconfig', targets)
294 i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
296 i_n = ienv.Install(env.get('BUILD_DIR') + 'lib/pkgconfig', targets)
297 ienv.Alias("install", i_n)
299 def __append_target(ienv, name, targets = None):
301 env.Alias(name, targets)
302 env.AppendUnique(TS = [name])
304 def __print_targets(env):
306 ===============================================================================
308 for t in env.get('TS'):
311 \nDefault all targets will be built. You can specify the target to build:
313 $ scons [options] [target]
314 ===============================================================================
317 env.AddMethod(__set_dir, 'SetDir')
318 env.AddMethod(__print_targets, 'PrintTargets')
319 env.AddMethod(__src_to_obj, 'SrcToObj')
320 env.AddMethod(__append_target, 'AppendTarget')
321 env.AddMethod(__install, 'InstallTarget')
322 env.AddMethod(__installlib, 'UserInstallTargetLib')
323 env.AddMethod(__installbin, 'UserInstallTargetBin')
324 env.AddMethod(__installheader, 'UserInstallTargetHeader')
325 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
326 env.SetDir(env.GetLaunchDir())
327 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
331 ######################################################################
332 # Scons to generate the iotivity.pc file from iotivity.pc.in file
333 ######################################################################
334 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
336 user_prefix = env.get('PREFIX')
337 user_lib = env.get('LIB_INSTALL_DIR')
340 user_prefix = env.get('BUILD_DIR').encode('string_escape')
343 user_lib = '$${prefix}/lib'
346 if env.get('LOGGING'):
347 defines.append('-DTB_LOG=1')
349 if env.get('ROUTING') == 'GW':
350 defines.append('-DROUTING_GATEWAY=1')
351 elif env.get('ROUTING') == 'EP':
352 defines.append('-DROUTING_EP=1')
354 if env.get('WITH_TCP'):
355 defines.append('-DTCP_ADAPTER=1')
356 if env.get('SECURED') == '1':
357 defines.append('-D__WITH_TLS__=1')
359 if env.get('DISABLE_TCP_SERVER'):
360 defines.append('-DDISABLE_TCP_SERVER=1')
362 if env.get('DISABLE_PRESENCE') == False:
363 env.AppendUnique(CPPDEFINES = ['WITH_PRESENCE'])
366 if env.get('SECURED') == '1':
367 defines.append('-D__WITH_DTLS__=1')
368 if env.get('EXC_PROV_SUPPORT') == '0':
369 libs.append('-locpmapi') # CAPI
370 libs.append('-locprovision') # C++API
373 '\@VERSION\@': project_version,
374 '\@PREFIX\@': user_prefix,
375 '\@EXEC_PREFIX\@': user_prefix,
376 '\@LIB_INSTALL_DIR\@': user_lib,
377 '\@DEFINES\@': " ".join(defines),
378 '\@LIBS\@': " ".join(libs)
381 env.Substfile(pc_file, SUBST_DICT = pc_vars)
383 ######################################################################
384 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
385 ######################################################################
386 if target_os == "yocto":
388 This code injects Yocto cross-compilation tools+flags into scons'
389 build environment in order to invoke the relevant tools while
394 CC = os.environ['CC']
395 target_prefix = CC.split()[0]
396 target_prefix = target_prefix[:len(target_prefix)-3]
397 tools = {"CC" : target_prefix+"gcc",
398 "CXX" : target_prefix+"g++",
399 "AS" : target_prefix+"as",
400 "LD" : target_prefix+"ld",
401 "GDB" : target_prefix+"gdb",
402 "STRIP" : target_prefix+"strip",
403 "RANLIB" : target_prefix+"ranlib",
404 "OBJCOPY" : target_prefix+"objcopy",
405 "OBJDUMP" : target_prefix+"objdump",
406 "AR" : target_prefix+"ar",
407 "NM" : target_prefix+"nm",
409 "STRINGS": target_prefix+"strings"}
410 PATH = os.environ['PATH'].split(os.pathsep)
412 if tool in os.environ:
414 if os.path.isfile(os.path.join(path, tools[tool])):
415 env[tool] = os.path.join(path, os.environ[tool])
417 env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
418 if os.environ['LDFLAGS'] != None:
419 env.AppendUnique(LINKFLAGS = Split(os.environ['LDFLAGS']))
421 print "ERROR in Yocto cross-toolchain environment"
424 Now reset TARGET_OS to linux so that all linux specific build configurations
425 hereupon apply for the entirety of the build process.
427 env['TARGET_OS'] = 'linux'
429 We want to preserve debug symbols to allow BitBake to generate both DEBUG and
430 RELEASE packages for OIC.
432 env.AppendUnique(CCFLAGS = ['-g'])
434 Additional flags to pass to the Yocto toolchain.
436 if env.get('RELEASE'):
437 env.AppendUnique(CPPDEFINES = ['NDEBUG'])
438 if env.get('LOGGING'):
439 env.AppendUnique(CPPDEFINES = ['TB_LOG'])
440 env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
441 env.AppendUnique(CFLAGS = ['-std=gnu99'])
442 env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
443 env.AppendUnique(LIBS = ['dl', 'pthread', 'uuid'])
447 If target_os is not Yocto, continue with the regular build process
449 # Load config of target os
450 env.SConscript(target_os + '/SConscript')
452 # Delete the temp files of configuration
453 if env.GetOption('clean'):
454 dir = env.get('SRC_DIR')
456 if os.path.exists(dir + '/config.log'):
457 Execute(Delete(dir + '/config.log'))
458 if os.path.exists(dir + '/.sconsign.dblite'):
459 Execute(Delete(dir + '/.sconsign.dblite'))
460 if os.path.exists(dir + '/.sconf_temp'):
461 Execute(Delete(dir + '/.sconf_temp'))
463 ######################################################################
464 # Check for PThreads support
465 ######################################################################
466 import iotivityconfig
467 from iotivityconfig import *
469 conf = Configure(env,
472 'CheckPThreadsSupport' : iotivityconfig.check_pthreads
475 # Identify whether we have pthreads support, which is necessary for
476 # threading and mutexes. This will set the environment variable
477 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
478 conf.CheckPThreadsSupport()
481 ######################################################################
483 env.SConscript('external_libs.scons')