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))
82 help_vars.Add(BoolVariable('WITH_TCP', 'Build with TCP adapter', False))
83 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
84 help_vars.Add(EnumVariable('WITH_RD', 'Build including Resource Directory', '0', allowed_values=('0', '1')))
86 if target_os in targets_disallow_multitransport:
87 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP']))
89 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP']))
91 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
92 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
93 help_vars.Add(EnumVariable('DTLS_WITH_X509', 'DTLS with X.509 support', '0', allowed_values=('0', '1')))
94 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
95 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
96 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
97 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
98 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
99 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
100 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
101 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
102 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
104 AddOption('--prefix',
110 help='installation prefix')
112 ######################################################################
113 # Platform(build target) specific options: SDK/NDK & toolchain
114 ######################################################################
115 targets_support_cc = ['linux', 'arduino', 'tizen']
117 if target_os in targets_support_cc:
118 # Set cross compile toolchain
119 help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
120 help_vars.Add(PathVariable('TC_PATH',
121 'Toolchain path (Generally only be required for cross-compiling)',
122 os.environ.get('TC_PATH')))
124 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
125 env = Environment(variables = help_vars,
126 tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
129 env = Environment(variables = help_vars, tools = ['default', 'textfile'], TARGET_ARCH = target_arch, TARGET_OS = target_os, PREFIX = GetOption('prefix'), INSTALL_ROOT = ARGUMENTS.get('INSTALL_ROOT', dir))
130 Help(help_vars.GenerateHelpText(env))
133 ************************************ Warning **********************************
134 * Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
135 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
136 * cause inexplicable errors. *
137 *******************************************************************************
139 if env.get('VERBOSE') == False:
140 env['CCCOMSTR'] = "Compiling $TARGET"
141 env['SHCCCOMSTR'] = "Compiling $TARGET"
142 env['CXXCOMSTR'] = "Compiling $TARGET"
143 env['SHCXXCOMSTR'] = "Compiling $TARGET"
144 env['LINKCOMSTR'] = "Linking $TARGET"
145 env['SHLINKCOMSTR'] = "Linking $TARGET"
146 env['ARCOMSTR'] = "Archiving $TARGET"
147 env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
149 if target_os in targets_support_cc:
150 prefix = env.get('TC_PREFIX')
151 tc_path = env.get('TC_PATH')
153 env.Replace(CC = prefix + env.get('CC', 'gcc'))
154 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
155 env.Replace(AR = prefix + env.get('AR', 'ar'))
156 env.Replace(AS = prefix + env.get('AS', 'as'))
157 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
160 env.PrependENVPath('PATH', tc_path)
161 sys_root = os.path.abspath(tc_path + '/../')
162 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
163 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
165 if prefix or tc_path:
168 # Ensure scons be able to change its working directory
169 env.SConscriptChdir(1)
171 # Set the source directory and build directory
172 # Source directory: 'dir'
173 # Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
175 # You can get the directory as following:
177 # env.get('BUILD_DIR')
179 def __set_dir(env, dir):
180 if not os.path.exists(dir + '/SConstruct'):
182 *************************************** Error *********************************
183 * The directory(%s) seems isn't a source code directory, no SConstruct file is
185 *******************************************************************************
189 if env.get('RELEASE'):
190 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
192 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
193 env.VariantDir(build_dir, dir, duplicate=0)
195 env.Replace(BUILD_DIR = build_dir)
196 env.Replace(SRC_DIR = dir)
198 def __src_to_obj(env, src, home = ''):
199 obj = env.get('BUILD_DIR') + src.replace(home, '')
200 if env.get('OBJSUFFIX'):
201 obj += env.get('OBJSUFFIX')
202 return env.Object(obj, src)
204 def __install(ienv, targets, name):
205 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
207 env.AppendUnique(TS = [name])
209 def __installlib(ienv, targets, name):
210 user_prefix = env.get('PREFIX')
212 i_n = ienv.Install(env.get('INSTALL_ROOT') + user_prefix + '/lib', targets)
214 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
215 ienv.Alias("install", i_n)
217 def __installbin(ienv, targets, name):
218 user_prefix = env.get('PREFIX')
220 i_n = ienv.Install(env.get('INSTALL_ROOT') + user_prefix + '/bin', targets)
222 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
223 ienv.Alias("install", i_n)
225 def __installheader(ienv, targets, dir, name):
226 user_prefix = env.get('PREFIX')
228 i_n = ienv.Install(env.get('INSTALL_ROOT') + user_prefix + '/include/' + dir ,targets)
230 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
231 ienv.Alias("install", i_n)
233 def __installpcfile(ienv, targets, name):
234 user_prefix = env.get('PREFIX')
236 i_n = ienv.Install(env.get('INSTALL_ROOT') + user_prefix + '/lib/pkgconfig', targets)
238 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
239 ienv.Alias("install", i_n)
241 def __append_target(ienv, name, targets = None):
243 env.Alias(name, targets)
244 env.AppendUnique(TS = [name])
246 def __print_targets(env):
248 ===============================================================================
250 for t in env.get('TS'):
253 \nDefault all targets will be built. You can specify the target to build:
255 $ scons [options] [target]
256 ===============================================================================
259 env.AddMethod(__set_dir, 'SetDir')
260 env.AddMethod(__print_targets, 'PrintTargets')
261 env.AddMethod(__src_to_obj, 'SrcToObj')
262 env.AddMethod(__append_target, 'AppendTarget')
263 env.AddMethod(__install, 'InstallTarget')
264 env.AddMethod(__installlib, 'UserInstallTargetLib')
265 env.AddMethod(__installbin, 'UserInstallTargetBin')
266 env.AddMethod(__installheader, 'UserInstallTargetHeader')
267 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
268 env.SetDir(env.GetLaunchDir())
269 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
273 ######################################################################
274 # Scons to generate the iotivity.pc file from iotivity.pc.in file
275 ######################################################################
276 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
278 if env.get('ROUTING') == 'GW':
279 routing_define = 'ROUTING_GATEWAY'
280 elif env.get('ROUTING') == 'EP':
281 routing_define = 'ROUTING_EP'
283 user_prefix = env.get('PREFIX')
286 pc_vars = {'\@PREFIX\@': user_prefix, '\@EXEC_PREFIX\@':user_prefix, '\@VERSION\@':'1.0.0', '\@ROUTING_DEFINE\@': routing_define}
288 pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'), '\@EXEC_PREFIX\@': env.get('BUILD_DIR'), '\@VERSION\@':'1.0.0', '\@ROUTING_DEFINE\@': routing_define}
290 env.Substfile(pc_file, SUBST_DICT = pc_vars)
292 ######################################################################
293 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
294 ######################################################################
295 if target_os == "yocto":
297 This code injects Yocto cross-compilation tools+flags into scons'
298 build environment in order to invoke the relevant tools while
303 CC = os.environ['CC']
304 target_prefix = CC.split()[0]
305 target_prefix = target_prefix[:len(target_prefix)-3]
306 tools = {"CC" : target_prefix+"gcc",
307 "CXX" : target_prefix+"g++",
308 "AS" : target_prefix+"as",
309 "LD" : target_prefix+"ld",
310 "GDB" : target_prefix+"gdb",
311 "STRIP" : target_prefix+"strip",
312 "RANLIB" : target_prefix+"ranlib",
313 "OBJCOPY" : target_prefix+"objcopy",
314 "OBJDUMP" : target_prefix+"objdump",
315 "AR" : target_prefix+"ar",
316 "NM" : target_prefix+"nm",
318 "STRINGS": target_prefix+"strings"}
319 PATH = os.environ['PATH'].split(os.pathsep)
321 if tool in os.environ:
323 if os.path.isfile(os.path.join(path, tools[tool])):
324 env[tool] = os.path.join(path, os.environ[tool])
326 env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
328 print "ERROR in Yocto cross-toolchain environment"
331 Now reset TARGET_OS to linux so that all linux specific build configurations
332 hereupon apply for the entirety of the build process.
334 env['TARGET_OS'] = 'linux'
336 We want to preserve debug symbols to allow BitBake to generate both DEBUG and
337 RELEASE packages for OIC.
339 env.AppendUnique(CCFLAGS = ['-g'])
341 Additional flags to pass to the Yocto toolchain.
343 if env.get('RELEASE'):
344 env.AppendUnique(CPPDEFINES = ['NDEBUG'])
345 if env.get('LOGGING'):
346 env.AppendUnique(CPPDEFINES = ['TB_LOG'])
347 env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
348 env.AppendUnique(CFLAGS = ['-std=gnu99'])
349 env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
350 env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
351 env.AppendUnique(LIBS = ['uuid'])
355 If target_os is not Yocto, continue with the regular build process
357 # Load config of target os
358 env.SConscript(target_os + '/SConscript')
360 # Delete the temp files of configuration
361 if env.GetOption('clean'):
362 dir = env.get('SRC_DIR')
364 if os.path.exists(dir + '/config.log'):
365 Execute(Delete(dir + '/config.log'))
366 if os.path.exists(dir + '/.sconsign.dblite'):
367 Execute(Delete(dir + '/.sconsign.dblite'))
368 if os.path.exists(dir + '/.sconf_temp'):
369 Execute(Delete(dir + '/.sconf_temp'))
371 ######################################################################
372 # Check for PThreads support
373 ######################################################################
374 import iotivityconfig
375 from iotivityconfig import *
377 conf = Configure(env,
380 'CheckPThreadsSupport' : iotivityconfig.check_pthreads
383 # Identify whether we have pthreads support, which is necessary for
384 # threading and mutexes. This will set the environment variable
385 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
386 conf.CheckPThreadsSupport()
389 ######################################################################
391 env.SConscript('external_libs.scons')