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.0'
11 # Map of host os and allowed target os (host: allowed target os)
13 'linux': ['linux', 'android', 'arduino', 'yocto', 'tizen'],
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', 'powerpc', 'powerpc64', 'mips', 'mipsel'],
32 host = platform.system().lower()
34 # the host string contains version of windows. 6.3, 6.4, 10.0 which is 8.0, 8.1, and 10 respectively.
35 # Let's canonicalize the msys_nt-XX.X system name by stripping version off.
39 if not host_target_map.has_key(host):
40 print "\nError: Current system (%s) isn't supported\n" % host
43 ######################################################################
44 # Get build options (the optins from command line)
45 ######################################################################
46 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
48 if target_os not in host_target_map[host]:
49 print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
52 if target_os == 'android':
55 default_arch = platform.machine()
57 if default_arch not in os_arch_map[target_os]:
58 default_arch = os_arch_map[target_os][0].lower()
60 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
62 # True if binary needs to be installed on board. (Might need root permissions)
63 # set to 'no', 'false' or 0 for only compilation
64 require_upload = ARGUMENTS.get('UPLOAD', False)
66 # Get the device name. This name can be used as network display name wherever possible
67 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
69 default_with_upstream_libcoap = 0
71 if ARGUMENTS.get('TEST'):
72 logging_default = False
75 if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
77 logging_default = (release_mode == False)
79 # targets that do not support the DTLS build (SECURED=1 build option)
80 targets_without_dtls_support = ['arduino'];
81 if ARGUMENTS.get('SECURED') == '1' and target_os in targets_without_dtls_support:
82 print "\nError: DTLS not supported on target os: %s MUST build with SECURED=0\n" % (target_os)
85 ######################################################################
86 # Common build options (release, target os, target arch)
87 ######################################################################
88 targets_disallow_multitransport = ['arduino']
90 help_vars = Variables()
91 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
92 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
93 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
96 help_vars.Add(BoolVariable('WITH_RA', 'Build with Remote Access module', False))
97 help_vars.Add(BoolVariable('WITH_TCP', 'Build with TCP adapter', False))
98 help_vars.Add(BoolVariable('WITH_PROXY', 'Build with CoAP-HTTP Proxy', False))
99 help_vars.Add(ListVariable('WITH_MQ', 'Build with MQ publisher/broker', 'OFF', ['OFF', 'SUB', 'PUB', 'BROKER']))
100 help_vars.Add(BoolVariable('WITH_CLOUD', 'Build including AccountManager class and Cloud Client sample', False))
101 help_vars.Add(ListVariable('RD_MODE', 'Resource Directory build mode', 'CLIENT', ['CLIENT', 'SERVER']))
103 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
105 help_vars.Add(BoolVariable('WITH_RA_IBB', 'Build with Remote Access module(workssys)', False))
108 if target_os in targets_disallow_multitransport:
109 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP', 'NFC']))
111 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'NFC']))
113 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
114 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
115 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
116 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
117 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
118 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
119 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
120 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
121 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
122 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
123 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
124 help_vars.Add(EnumVariable('WITH_UPSTREAM_LIBCOAP', 'Use latest stable version of LibCoAP downloaded from github', default_with_upstream_libcoap, allowed_values=('0','1')))
126 AddOption('--prefix',
132 help='installation prefix')
134 ######################################################################
135 # Platform(build target) specific options: SDK/NDK & toolchain
136 ######################################################################
137 targets_support_cc = ['linux', 'arduino', 'tizen']
139 if target_os in targets_support_cc:
140 # Set cross compile toolchain
141 help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
142 help_vars.Add(PathVariable('TC_PATH',
143 'Toolchain path (Generally only be required for cross-compiling)',
144 os.environ.get('TC_PATH')))
146 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
147 env = Environment(variables = help_vars,
148 tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
151 env = Environment(variables = help_vars, tools = ['default', 'textfile'],
152 TARGET_ARCH = target_arch, TARGET_OS = target_os,
153 PREFIX = GetOption('prefix'),
154 LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR') #for 64bit build
156 Help(help_vars.GenerateHelpText(env))
159 ************************************ Warning **********************************
160 * Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
161 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
162 * cause inexplicable errors. *
163 *******************************************************************************
165 if env.get('VERBOSE') == False:
166 env['CCCOMSTR'] = "Compiling $TARGET"
167 env['SHCCCOMSTR'] = "Compiling $TARGET"
168 env['CXXCOMSTR'] = "Compiling $TARGET"
169 env['SHCXXCOMSTR'] = "Compiling $TARGET"
170 env['LINKCOMSTR'] = "Linking $TARGET"
171 env['SHLINKCOMSTR'] = "Linking $TARGET"
172 env['ARCOMSTR'] = "Archiving $TARGET"
173 env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
175 if target_os in targets_support_cc:
176 prefix = env.get('TC_PREFIX')
177 tc_path = env.get('TC_PATH')
179 env.Replace(CC = prefix + env.get('CC', 'gcc'))
180 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
181 env.Replace(AR = prefix + env.get('AR', 'ar'))
182 env.Replace(AS = prefix + env.get('AS', 'as'))
183 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
186 env.PrependENVPath('PATH', tc_path)
187 sys_root = os.path.abspath(tc_path + '/../')
188 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
189 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
191 if prefix or tc_path:
194 # If cross-compiling, honor environment settings for toolchain to avoid picking up native tools
195 if os.environ.get('PKG_CONFIG') != None:
196 env["ENV"]["PKG_CONFIG"] = os.environ.get("PKG_CONFIG")
197 if os.environ.get('PKG_CONFIG_PATH') != None:
198 env["ENV"]["PKG_CONFIG_PATH"] = os.environ.get("PKG_CONFIG_PATH")
199 if os.environ.get('PKG_CONFIG_SYSROOT_DIR') != None:
200 env["ENV"]["PKG_CONFIG_SYSROOT_DIR"] = os.environ.get("PKG_CONFIG_SYSROOT_DIR")
202 # Ensure scons be able to change its working directory
203 env.SConscriptChdir(1)
205 # Set the source directory and build directory
206 # Source directory: 'dir'
207 # Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
209 # You can get the directory as following:
211 # env.get('BUILD_DIR')
213 def __set_dir(env, dir):
214 if not os.path.exists(dir + '/SConstruct'):
216 *************************************** Error *********************************
217 * The directory(%s) seems isn't a source code directory, no SConstruct file is
219 *******************************************************************************
223 if env.get('RELEASE'):
224 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
226 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
227 env.VariantDir(build_dir, dir, duplicate=0)
229 env.Replace(BUILD_DIR = build_dir)
230 env.Replace(SRC_DIR = dir)
232 def __src_to_obj(env, src, home = ''):
233 obj = env.get('BUILD_DIR') + src.replace(home, '')
234 if env.get('OBJSUFFIX'):
235 obj += env.get('OBJSUFFIX')
236 return env.Object(obj, src)
238 def __install(ienv, targets, name):
239 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
241 env.AppendUnique(TS = [name])
243 def __installlib(ienv, targets, name):
244 user_prefix = env.get('PREFIX')
246 user_lib = env.get('LIB_INSTALL_DIR')
248 i_n = ienv.Install(user_lib, targets)
250 i_n = ienv.Install(user_prefix + '/lib', targets)
251 ienv.Alias("install", i_n)
253 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
254 ienv.Alias("install", i_n)
256 def __installbin(ienv, targets, name):
257 user_prefix = env.get('PREFIX')
259 i_n = ienv.Install(user_prefix + '/bin', targets)
260 ienv.Alias("install", i_n)
262 def __installheader(ienv, targets, dir, name):
263 user_prefix = env.get('PREFIX')
265 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
267 i_n = ienv.Install(os.path.join(env.get('BUILD_DIR'), 'include', dir), targets)
268 ienv.Alias("install", i_n)
270 def __installpcfile(ienv, targets, name):
271 user_prefix = env.get('PREFIX')
273 user_lib = env.get('LIB_INSTALL_DIR')
275 i_n = ienv.Install(user_lib + '/pkgconfig', targets)
277 i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
279 i_n = ienv.Install(env.get('BUILD_DIR') + 'lib/pkgconfig', targets)
280 ienv.Alias("install", i_n)
282 def __append_target(ienv, name, targets = None):
284 env.Alias(name, targets)
285 env.AppendUnique(TS = [name])
287 def __print_targets(env):
289 ===============================================================================
291 for t in env.get('TS'):
294 \nDefault all targets will be built. You can specify the target to build:
296 $ scons [options] [target]
297 ===============================================================================
300 env.AddMethod(__set_dir, 'SetDir')
301 env.AddMethod(__print_targets, 'PrintTargets')
302 env.AddMethod(__src_to_obj, 'SrcToObj')
303 env.AddMethod(__append_target, 'AppendTarget')
304 env.AddMethod(__install, 'InstallTarget')
305 env.AddMethod(__installlib, 'UserInstallTargetLib')
306 env.AddMethod(__installbin, 'UserInstallTargetBin')
307 env.AddMethod(__installheader, 'UserInstallTargetHeader')
308 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
309 env.SetDir(env.GetLaunchDir())
310 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
314 ######################################################################
315 # Scons to generate the iotivity.pc file from iotivity.pc.in file
316 ######################################################################
317 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
319 user_prefix = env.get('PREFIX')
320 user_lib = env.get('LIB_INSTALL_DIR')
323 user_prefix = env.get('BUILD_DIR').encode('string_escape')
326 user_lib = '$${prefix}/lib'
329 if env.get('LOGGING'):
330 defines.append('-DTB_LOG=1')
332 if env.get('ROUTING') == 'GW':
333 defines.append('-DROUTING_GATEWAY=1')
334 elif env.get('ROUTING') == 'EP':
335 defines.append('-DROUTING_EP=1')
338 '\@VERSION\@': project_version,
339 '\@PREFIX\@': user_prefix,
340 '\@EXEC_PREFIX\@': user_prefix,
341 '\@LIB_INSTALL_DIR\@': user_lib,
342 '\@DEFINES\@': " ".join(defines)
345 env.Substfile(pc_file, SUBST_DICT = pc_vars)
347 ######################################################################
348 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
349 ######################################################################
350 if target_os == "yocto":
352 This code injects Yocto cross-compilation tools+flags into scons'
353 build environment in order to invoke the relevant tools while
358 CC = os.environ['CC']
359 target_prefix = CC.split()[0]
360 target_prefix = target_prefix[:len(target_prefix)-3]
361 tools = {"CC" : target_prefix+"gcc",
362 "CXX" : target_prefix+"g++",
363 "AS" : target_prefix+"as",
364 "LD" : target_prefix+"ld",
365 "GDB" : target_prefix+"gdb",
366 "STRIP" : target_prefix+"strip",
367 "RANLIB" : target_prefix+"ranlib",
368 "OBJCOPY" : target_prefix+"objcopy",
369 "OBJDUMP" : target_prefix+"objdump",
370 "AR" : target_prefix+"ar",
371 "NM" : target_prefix+"nm",
373 "STRINGS": target_prefix+"strings"}
374 PATH = os.environ['PATH'].split(os.pathsep)
376 if tool in os.environ:
378 if os.path.isfile(os.path.join(path, tools[tool])):
379 env[tool] = os.path.join(path, os.environ[tool])
381 env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
382 if os.environ['LDFLAGS'] != None:
383 env.AppendUnique(LINKFLAGS = Split(os.environ['LDFLAGS']))
385 print "ERROR in Yocto cross-toolchain environment"
388 Now reset TARGET_OS to linux so that all linux specific build configurations
389 hereupon apply for the entirety of the build process.
391 env['TARGET_OS'] = 'linux'
393 We want to preserve debug symbols to allow BitBake to generate both DEBUG and
394 RELEASE packages for OIC.
396 env.AppendUnique(CCFLAGS = ['-g'])
398 Additional flags to pass to the Yocto toolchain.
400 if env.get('RELEASE'):
401 env.AppendUnique(CPPDEFINES = ['NDEBUG'])
402 if env.get('LOGGING'):
403 env.AppendUnique(CPPDEFINES = ['TB_LOG'])
404 env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
405 env.AppendUnique(CFLAGS = ['-std=gnu99'])
406 env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
407 env.AppendUnique(LIBS = ['dl', 'pthread', 'uuid'])
411 If target_os is not Yocto, continue with the regular build process
413 # Load config of target os
414 env.SConscript(target_os + '/SConscript')
416 # Delete the temp files of configuration
417 if env.GetOption('clean'):
418 dir = env.get('SRC_DIR')
420 if os.path.exists(dir + '/config.log'):
421 Execute(Delete(dir + '/config.log'))
422 if os.path.exists(dir + '/.sconsign.dblite'):
423 Execute(Delete(dir + '/.sconsign.dblite'))
424 if os.path.exists(dir + '/.sconf_temp'):
425 Execute(Delete(dir + '/.sconf_temp'))
427 ######################################################################
428 # Check for PThreads support
429 ######################################################################
430 import iotivityconfig
431 from iotivityconfig import *
433 conf = Configure(env,
436 'CheckPThreadsSupport' : iotivityconfig.check_pthreads
439 # Identify whether we have pthreads support, which is necessary for
440 # threading and mutexes. This will set the environment variable
441 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
442 conf.CheckPThreadsSupport()
445 ######################################################################
447 env.SConscript('external_libs.scons')