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']
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(EnumVariable('WITH_RD', 'Build including Resource Directory', '0', allowed_values=('0', '1')))
84 help_vars.Add(BoolVariable('WITH_CLOUD', 'Build including Cloud client sample', False))
86 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
88 help_vars.Add(BoolVariable('WITH_RA_IBB', 'Build with Remote Access module(workssys)', False))
91 if target_os in targets_disallow_multitransport:
92 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP', 'NFC']))
94 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'NFC']))
96 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
97 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
98 help_vars.Add(EnumVariable('DTLS_WITH_X509', 'DTLS with X.509 support', '0', allowed_values=('0', '1')))
99 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
100 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
101 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
102 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
103 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
104 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
105 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
106 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
107 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
108 #ES_TARGET_ENROLLEE is for specifying what is our target enrollee (Arduino or rest of platforms which support Multicast)
109 help_vars.Add(EnumVariable('ES_TARGET_ENROLLEE', 'Target Enrollee', 'arduino', allowed_values=('arduino', 'tizen', 'linux')))
110 #ES_ROLE is for specifying the role (Enrollee or Mediator) for which scons is being executed
111 help_vars.Add(EnumVariable('ES_ROLE', 'Target build mode', 'mediator', allowed_values=('mediator', 'enrollee')))
112 #ES_SOFT_MODE is for specifying MODE (Mode 1 : Enrollee with Soft AP or Mode 2 : Mediator with Soft AP)
113 help_vars.Add(EnumVariable('ES_SOFTAP_MODE', 'Target build mode', 'ENROLLEE_SOFTAP', allowed_values=('ENROLLEE_SOFTAP', 'MEDIATOR_SOFTAP')))
115 AddOption('--prefix',
121 help='installation prefix')
123 ######################################################################
124 # Platform(build target) specific options: SDK/NDK & toolchain
125 ######################################################################
126 targets_support_cc = ['linux', 'arduino', 'tizen']
128 if target_os in targets_support_cc:
129 # Set cross compile toolchain
130 help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
131 help_vars.Add(PathVariable('TC_PATH',
132 'Toolchain path (Generally only be required for cross-compiling)',
133 os.environ.get('TC_PATH')))
135 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
136 env = Environment(variables = help_vars,
137 tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
140 env = Environment(variables = help_vars, tools = ['default', 'textfile'],
141 TARGET_ARCH = target_arch, TARGET_OS = target_os,
142 PREFIX = GetOption('prefix'),
143 LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR') #for 64bit build
145 Help(help_vars.GenerateHelpText(env))
148 ************************************ Warning **********************************
149 * Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
150 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
151 * cause inexplicable errors. *
152 *******************************************************************************
154 if env.get('VERBOSE') == False:
155 env['CCCOMSTR'] = "Compiling $TARGET"
156 env['SHCCCOMSTR'] = "Compiling $TARGET"
157 env['CXXCOMSTR'] = "Compiling $TARGET"
158 env['SHCXXCOMSTR'] = "Compiling $TARGET"
159 env['LINKCOMSTR'] = "Linking $TARGET"
160 env['SHLINKCOMSTR'] = "Linking $TARGET"
161 env['ARCOMSTR'] = "Archiving $TARGET"
162 env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
164 if target_os in targets_support_cc:
165 prefix = env.get('TC_PREFIX')
166 tc_path = env.get('TC_PATH')
168 env.Replace(CC = prefix + env.get('CC', 'gcc'))
169 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
170 env.Replace(AR = prefix + env.get('AR', 'ar'))
171 env.Replace(AS = prefix + env.get('AS', 'as'))
172 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
175 env.PrependENVPath('PATH', tc_path)
176 sys_root = os.path.abspath(tc_path + '/../')
177 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
178 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
180 if prefix or tc_path:
183 # Ensure scons be able to change its working directory
184 env.SConscriptChdir(1)
186 # Set the source directory and build directory
187 # Source directory: 'dir'
188 # Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
190 # You can get the directory as following:
192 # env.get('BUILD_DIR')
194 def __set_dir(env, dir):
195 if not os.path.exists(dir + '/SConstruct'):
197 *************************************** Error *********************************
198 * The directory(%s) seems isn't a source code directory, no SConstruct file is
200 *******************************************************************************
204 if env.get('RELEASE'):
205 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
207 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
208 env.VariantDir(build_dir, dir, duplicate=0)
210 env.Replace(BUILD_DIR = build_dir)
211 env.Replace(SRC_DIR = dir)
213 def __src_to_obj(env, src, home = ''):
214 obj = env.get('BUILD_DIR') + src.replace(home, '')
215 if env.get('OBJSUFFIX'):
216 obj += env.get('OBJSUFFIX')
217 return env.Object(obj, src)
219 def __install(ienv, targets, name):
220 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
222 env.AppendUnique(TS = [name])
224 def __installlib(ienv, targets, name):
225 user_prefix = env.get('PREFIX')
227 user_lib = env.get('LIB_INSTALL_DIR')
229 i_n = ienv.Install(user_lib, targets)
231 i_n = ienv.Install(user_prefix + '/lib', targets)
232 ienv.Alias("install", i_n)
234 def __installbin(ienv, targets, name):
235 user_prefix = env.get('PREFIX')
237 i_n = ienv.Install(user_prefix + '/bin', targets)
238 ienv.Alias("install", i_n)
240 def __installheader(ienv, targets, dir, name):
241 user_prefix = env.get('PREFIX')
243 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
244 ienv.Alias("install", i_n)
246 def __installpcfile(ienv, targets, name):
247 user_prefix = env.get('PREFIX')
249 user_lib = env.get('LIB_INSTALL_DIR')
251 i_n = ienv.Install(user_lib + '/pkgconfig', targets)
253 i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
254 ienv.Alias("install", i_n)
256 def __append_target(ienv, name, targets = None):
258 env.Alias(name, targets)
259 env.AppendUnique(TS = [name])
261 def __print_targets(env):
263 ===============================================================================
265 for t in env.get('TS'):
268 \nDefault all targets will be built. You can specify the target to build:
270 $ scons [options] [target]
271 ===============================================================================
274 env.AddMethod(__set_dir, 'SetDir')
275 env.AddMethod(__print_targets, 'PrintTargets')
276 env.AddMethod(__src_to_obj, 'SrcToObj')
277 env.AddMethod(__append_target, 'AppendTarget')
278 env.AddMethod(__install, 'InstallTarget')
279 env.AddMethod(__installlib, 'UserInstallTargetLib')
280 env.AddMethod(__installbin, 'UserInstallTargetBin')
281 env.AddMethod(__installheader, 'UserInstallTargetHeader')
282 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
283 env.SetDir(env.GetLaunchDir())
284 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
288 ######################################################################
289 # Scons to generate the iotivity.pc file from iotivity.pc.in file
290 ######################################################################
291 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
293 if env.get('ROUTING') == 'GW':
294 routing_define = 'ROUTING_GATEWAY'
295 elif env.get('ROUTING') == 'EP':
296 routing_define = 'ROUTING_EP'
298 user_prefix = env.get('PREFIX')
299 user_lib = env.get('LIB_INSTALL_DIR')
301 user_lib = '$${prefix}/lib'
304 pc_vars = {'\@PREFIX\@': user_prefix,
305 '\@EXEC_PREFIX\@':user_prefix,
306 '\@VERSION\@': '1.0.1',
307 '\@LIB_INSTALL_DIR\@': user_lib,
308 '\@ROUTING_DEFINE\@': routing_define
311 pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'),
312 '\@EXEC_PREFIX\@': env.get('BUILD_DIR'),
313 '\@VERSION\@': '1.0.1',
314 '\@LIB_INSTALL_DIR\@': user_lib,
315 '\@ROUTING_DEFINE\@': routing_define
318 env.Substfile(pc_file, SUBST_DICT = pc_vars)
320 ######################################################################
321 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
322 ######################################################################
323 if target_os == "yocto":
325 This code injects Yocto cross-compilation tools+flags into scons'
326 build environment in order to invoke the relevant tools while
331 CC = os.environ['CC']
332 target_prefix = CC.split()[0]
333 target_prefix = target_prefix[:len(target_prefix)-3]
334 tools = {"CC" : target_prefix+"gcc",
335 "CXX" : target_prefix+"g++",
336 "AS" : target_prefix+"as",
337 "LD" : target_prefix+"ld",
338 "GDB" : target_prefix+"gdb",
339 "STRIP" : target_prefix+"strip",
340 "RANLIB" : target_prefix+"ranlib",
341 "OBJCOPY" : target_prefix+"objcopy",
342 "OBJDUMP" : target_prefix+"objdump",
343 "AR" : target_prefix+"ar",
344 "NM" : target_prefix+"nm",
346 "STRINGS": target_prefix+"strings"}
347 PATH = os.environ['PATH'].split(os.pathsep)
349 if tool in os.environ:
351 if os.path.isfile(os.path.join(path, tools[tool])):
352 env[tool] = os.path.join(path, os.environ[tool])
354 env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
356 print "ERROR in Yocto cross-toolchain environment"
359 Now reset TARGET_OS to linux so that all linux specific build configurations
360 hereupon apply for the entirety of the build process.
362 env['TARGET_OS'] = 'linux'
364 We want to preserve debug symbols to allow BitBake to generate both DEBUG and
365 RELEASE packages for OIC.
367 env.AppendUnique(CCFLAGS = ['-g'])
369 Additional flags to pass to the Yocto toolchain.
371 if env.get('RELEASE'):
372 env.AppendUnique(CPPDEFINES = ['NDEBUG'])
373 if env.get('LOGGING'):
374 env.AppendUnique(CPPDEFINES = ['TB_LOG'])
375 env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
376 env.AppendUnique(CFLAGS = ['-std=gnu99'])
377 env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
378 env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
379 env.AppendUnique(LIBS = ['uuid'])
383 If target_os is not Yocto, continue with the regular build process
385 # Load config of target os
386 env.SConscript(target_os + '/SConscript')
388 # Delete the temp files of configuration
389 if env.GetOption('clean'):
390 dir = env.get('SRC_DIR')
392 if os.path.exists(dir + '/config.log'):
393 Execute(Delete(dir + '/config.log'))
394 if os.path.exists(dir + '/.sconsign.dblite'):
395 Execute(Delete(dir + '/.sconsign.dblite'))
396 if os.path.exists(dir + '/.sconf_temp'):
397 Execute(Delete(dir + '/.sconf_temp'))
399 ######################################################################
400 # Check for PThreads support
401 ######################################################################
402 import iotivityconfig
403 from iotivityconfig import *
405 conf = Configure(env,
408 'CheckPThreadsSupport' : iotivityconfig.check_pthreads
411 # Identify whether we have pthreads support, which is necessary for
412 # threading and mutexes. This will set the environment variable
413 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
414 conf.CheckPThreadsSupport()
417 ######################################################################
419 env.SConscript('external_libs.scons')