2 # This script includes generic build options:
3 # release/debug, target os, target arch, cross toolchain, build environment etc
8 # Map of host os and allowed target os (host: allowed target os)
10 'linux': ['linux', 'android', 'arduino', 'yocto', 'tizen'],
11 'windows': ['windows', 'winrt', 'android', 'arduino'],
12 'darwin': ['darwin', 'ios', 'android', 'arduino'],
15 # Map of os and allowed archs (os: allowed archs)
17 'linux': ['x86', 'x86_64', 'arm', 'arm64'],
18 'tizen': ['x86', 'x86_64', 'arm', 'arm64', 'armeabi-v7a'],
19 'android': ['x86', 'x86_64', 'armeabi', 'armeabi-v7a', 'armeabi-v7a-hard', 'arm64-v8a'],
20 'windows': ['x86', 'amd64', 'arm'],
22 'darwin': ['i386', 'x86_64'],
23 'ios': ['i386', 'x86_64', 'armv7', 'armv7s', 'arm64'],
24 'arduino': ['avr', 'arm'],
25 'yocto': ['i586', 'x86_64', 'arm', 'powerpc', 'powerpc64', 'mips', 'mipsel'],
28 host = platform.system().lower()
30 if not host_target_map.has_key(host):
31 print "\nError: Current system (%s) isn't supported\n" % host
34 ######################################################################
35 # Get build options (the optins from command line)
36 ######################################################################
37 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
39 if target_os not in host_target_map[host]:
40 print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
43 if target_os == 'android':
46 default_arch = platform.machine()
48 if default_arch not in os_arch_map[target_os]:
49 default_arch = os_arch_map[target_os][0].lower()
51 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
53 # True if binary needs to be installed on board. (Might need root permissions)
54 # set to 'no', 'false' or 0 for only compilation
55 require_upload = ARGUMENTS.get('UPLOAD', False)
57 # Get the device name. This name can be used as network display name wherever possible
58 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
60 if ARGUMENTS.get('TEST'):
61 logging_default = False
64 if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
66 logging_default = (release_mode == False)
70 ######################################################################
71 # Common build options (release, target os, target arch)
72 ######################################################################
73 targets_disallow_multitransport = ['arduino', 'android']
75 help_vars = Variables()
76 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
77 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
78 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
81 help_vars.Add(BoolVariable('WITH_RA', 'Build with Remote Access module', False))
83 if target_os in targets_disallow_multitransport:
84 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP']))
86 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'TCP']))
88 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
89 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
90 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
91 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
92 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
93 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
94 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
95 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
96 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
97 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
98 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
100 AddOption('--prefix',
106 help='installation prefix')
108 ######################################################################
109 # Platform(build target) specific options: SDK/NDK & toolchain
110 ######################################################################
111 targets_support_cc = ['linux', 'arduino', 'tizen']
113 if target_os in targets_support_cc:
114 # Set cross compile toolchain
115 help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
116 help_vars.Add(PathVariable('TC_PATH',
117 'Toolchain path (Generally only be required for cross-compiling)',
118 os.environ.get('TC_PATH')))
120 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
121 env = Environment(variables = help_vars,
122 tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
125 env = Environment(variables = help_vars, tools = ['default', 'textfile'], TARGET_ARCH = target_arch, TARGET_OS = target_os, PREFIX = GetOption('prefix'))
127 Help(help_vars.GenerateHelpText(env))
130 ************************************ Warning **********************************
131 * Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
132 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
133 * cause inexplicable errors. *
134 *******************************************************************************
136 if env.get('VERBOSE') == False:
137 env['CCCOMSTR'] = "Compiling $TARGET"
138 env['SHCCCOMSTR'] = "Compiling $TARGET"
139 env['CXXCOMSTR'] = "Compiling $TARGET"
140 env['SHCXXCOMSTR'] = "Compiling $TARGET"
141 env['LINKCOMSTR'] = "Linking $TARGET"
142 env['SHLINKCOMSTR'] = "Linking $TARGET"
143 env['ARCOMSTR'] = "Archiving $TARGET"
144 env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
146 if target_os in targets_support_cc:
147 prefix = env.get('TC_PREFIX')
148 tc_path = env.get('TC_PATH')
150 env.Replace(CC = prefix + env.get('CC', 'gcc'))
151 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
152 env.Replace(AR = prefix + env.get('AR', 'ar'))
153 env.Replace(AS = prefix + env.get('AS', 'as'))
154 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
157 env.PrependENVPath('PATH', tc_path)
158 sys_root = os.path.abspath(tc_path + '/../')
159 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
160 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
162 if prefix or tc_path:
165 # Ensure scons be able to change its working directory
166 env.SConscriptChdir(1)
168 # Set the source directory and build directory
169 # Source directory: 'dir'
170 # Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
172 # You can get the directory as following:
174 # env.get('BUILD_DIR')
176 def __set_dir(env, dir):
177 if not os.path.exists(dir + '/SConstruct'):
179 *************************************** Error *********************************
180 * The directory(%s) seems isn't a source code directory, no SConstruct file is
182 *******************************************************************************
186 if env.get('RELEASE'):
187 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
189 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
190 env.VariantDir(build_dir, dir, duplicate=0)
192 env.Replace(BUILD_DIR = build_dir)
193 env.Replace(SRC_DIR = dir)
195 def __src_to_obj(env, src, home = ''):
196 obj = env.get('BUILD_DIR') + src.replace(home, '')
197 if env.get('OBJSUFFIX'):
198 obj += env.get('OBJSUFFIX')
199 return env.Object(obj, src)
201 def __install(ienv, targets, name):
202 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
204 env.AppendUnique(TS = [name])
206 def __installlib(ienv, targets, name):
207 user_prefix = env.get('PREFIX')
209 i_n = ienv.Install(user_prefix + '/lib', targets)
211 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
212 ienv.Alias("install", i_n)
214 def __installbin(ienv, targets, name):
215 user_prefix = env.get('PREFIX')
217 i_n = ienv.Install(user_prefix + '/bin', targets)
219 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
220 ienv.Alias("install", i_n)
222 def __installheader(ienv, targets, dir, name):
223 user_prefix = env.get('PREFIX')
225 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
227 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
228 ienv.Alias("install", i_n)
230 def __installpcfile(ienv, targets, name):
231 user_prefix = env.get('PREFIX')
233 i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
235 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
236 ienv.Alias("install", i_n)
238 def __append_target(ienv, name, targets = None):
240 env.Alias(name, targets)
241 env.AppendUnique(TS = [name])
243 def __print_targets(env):
245 ===============================================================================
247 for t in env.get('TS'):
250 \nDefault all targets will be built. You can specify the target to build:
252 $ scons [options] [target]
253 ===============================================================================
256 env.AddMethod(__set_dir, 'SetDir')
257 env.AddMethod(__print_targets, 'PrintTargets')
258 env.AddMethod(__src_to_obj, 'SrcToObj')
259 env.AddMethod(__append_target, 'AppendTarget')
260 env.AddMethod(__install, 'InstallTarget')
261 env.AddMethod(__installlib, 'UserInstallTargetLib')
262 env.AddMethod(__installbin, 'UserInstallTargetBin')
263 env.AddMethod(__installheader, 'UserInstallTargetHeader')
264 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
265 env.SetDir(env.GetLaunchDir())
266 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
270 ######################################################################
271 # Scons to generate the iotivity.pc file from iotivity.pc.in file
272 ######################################################################
273 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
275 user_prefix = env.get('PREFIX')
278 pc_vars = {'\@PREFIX\@': user_prefix, '\@EXEC_PREFIX\@':user_prefix, '\@VERSION\@':'0.9.2'}
280 pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'), '\@EXEC_PREFIX\@': env.get('BUILD_DIR'), '\@VERSION\@':'0.9.2'}
282 env.Substfile(pc_file, SUBST_DICT = pc_vars)
284 ######################################################################
285 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
286 ######################################################################
287 if target_os == "yocto":
289 This code injects Yocto cross-compilation tools+flags into scons'
290 build environment in order to invoke the relevant tools while
295 CC = os.environ['CC']
296 target_prefix = CC.split()[0]
297 target_prefix = target_prefix[:len(target_prefix)-3]
298 tools = {"CC" : target_prefix+"gcc",
299 "CXX" : target_prefix+"g++",
300 "AS" : target_prefix+"as",
301 "LD" : target_prefix+"ld",
302 "GDB" : target_prefix+"gdb",
303 "STRIP" : target_prefix+"strip",
304 "RANLIB" : target_prefix+"ranlib",
305 "OBJCOPY" : target_prefix+"objcopy",
306 "OBJDUMP" : target_prefix+"objdump",
307 "AR" : target_prefix+"ar",
308 "NM" : target_prefix+"nm",
310 "STRINGS": target_prefix+"strings"}
311 PATH = os.environ['PATH'].split(os.pathsep)
313 if tool in os.environ:
315 if os.path.isfile(os.path.join(path, tools[tool])):
316 env[tool] = os.path.join(path, os.environ[tool])
318 env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
320 print "ERROR in Yocto cross-toolchain environment"
323 Now reset TARGET_OS to linux so that all linux specific build configurations
324 hereupon apply for the entirety of the build process.
326 env['TARGET_OS'] = 'linux'
328 We want to preserve debug symbols to allow BitBake to generate both DEBUG and
329 RELEASE packages for OIC.
331 env.AppendUnique(CCFLAGS = ['-g'])
333 Additional flags to pass to the Yocto toolchain.
335 if env.get('RELEASE'):
336 env.AppendUnique(CPPDEFINES = ['NDEBUG'])
337 if env.get('LOGGING'):
338 env.AppendUnique(CPPDEFINES = ['TB_LOG'])
339 env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
340 env.AppendUnique(CFLAGS = ['-std=gnu99'])
341 env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
342 env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
343 env.AppendUnique(LIBS = ['uuid'])
347 If target_os is not Yocto, continue with the regular build process
349 # Load config of target os
350 env.SConscript(target_os + '/SConscript')
352 # Delete the temp files of configuration
353 if env.GetOption('clean'):
354 dir = env.get('SRC_DIR')
356 if os.path.exists(dir + '/config.log'):
357 Execute(Delete(dir + '/config.log'))
358 if os.path.exists(dir + '/.sconsign.dblite'):
359 Execute(Delete(dir + '/.sconsign.dblite'))
360 if os.path.exists(dir + '/.sconf_temp'):
361 Execute(Delete(dir + '/.sconf_temp'))
363 ######################################################################
364 # Check for PThreads support
365 ######################################################################
366 import iotivityconfig
367 from iotivityconfig import *
369 conf = Configure(env,
372 'CheckPThreadsSupport' : iotivityconfig.check_pthreads
375 # Identify whether we have pthreads support, which is necessary for
376 # threading and mutexes. This will set the environment variable
377 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
378 conf.CheckPThreadsSupport()
381 ######################################################################
383 env.SConscript('external_libs.scons')