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'],
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 default_arch = platform.machine()
44 if default_arch not in os_arch_map[target_os]:
45 default_arch = os_arch_map[target_os][0].lower()
47 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
49 # True if binary needs to be installed on board. (Might need root permissions)
50 # set to 'no', 'false' or 0 for only compilation
51 require_upload = ARGUMENTS.get('UPLOAD', True)
54 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
56 ######################################################################
57 # Common build options (release, target os, target arch)
58 ######################################################################
59 help_vars = Variables()
60 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
61 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', False))
62 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
63 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP']))
64 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
65 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
66 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
67 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
69 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device', 'OIC-DEVICE', None, None),)
77 help='installation prefix')
79 ######################################################################
80 # Platform(build target) specific options: SDK/NDK & toolchain
81 ######################################################################
82 targets_support_cc = ['linux', 'arduino', 'tizen']
84 if target_os in targets_support_cc:
85 # Set cross compile toolchain
86 help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
87 help_vars.Add(PathVariable('TC_PATH',
88 'Toolchain path (Generally only be required for cross-compiling)',
89 os.environ.get('TC_PATH')))
91 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
92 env = Environment(variables = help_vars,
93 tools = ['gnulink', 'gcc', 'g++', 'ar', 'as']
96 env = Environment(variables = help_vars, TARGET_ARCH = target_arch, TARGET_OS = target_os, PREFIX = GetOption('prefix'))
98 Help(help_vars.GenerateHelpText(env))
100 # Set device name to __OIC_DEVICE_NAME__
101 env.AppendUnique(CPPDEFINES = ['-D__OIC_DEVICE_NAME__=' + "\'\"" + device_name + "\"\'"])
104 ************************************ Warning **********************************
105 * Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
106 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
107 * cause inexplicable errors. *
108 *******************************************************************************
111 if target_os in targets_support_cc:
112 prefix = env.get('TC_PREFIX')
113 tc_path = env.get('TC_PATH')
115 env.Replace(CC = prefix + 'gcc')
116 env.Replace(CXX = prefix + 'g++')
117 env.Replace(AR = prefix + 'ar')
118 env.Replace(AS = prefix + 'as')
119 env.Replace(LINK = prefix + 'ld')
120 env.Replace(RANLIB = prefix + 'ranlib')
123 env.PrependENVPath('PATH', tc_path)
124 sys_root = os.path.abspath(tc_path + '/../')
125 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
126 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
128 if prefix or tc_path:
131 # Ensure scons be able to change its working directory
132 env.SConscriptChdir(1)
134 # Set the source directory and build directory
135 # Source directory: 'dir'
136 # Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
138 # You can get the directory as following:
140 # env.get('BUILD_DIR')
142 def __set_dir(env, dir):
143 if not os.path.exists(dir + '/SConstruct'):
145 *************************************** Error *********************************
146 * The directory(%s) seems isn't a source code directory, no SConstruct file is
148 *******************************************************************************
152 if env.get('RELEASE'):
153 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
155 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
156 env.VariantDir(build_dir, dir, duplicate=0)
158 env.Replace(BUILD_DIR = build_dir)
159 env.Replace(SRC_DIR = dir)
161 def __src_to_obj(env, src, home = ''):
162 obj = env.get('BUILD_DIR') + src.replace(home, '')
163 if env.get('OBJSUFFIX'):
164 obj += env.get('OBJSUFFIX')
165 return env.Object(obj, src)
167 def __install(ienv, targets, name):
168 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
170 env.AppendUnique(TS = [name])
172 def __installlib(ienv, targets, name):
173 user_prefix = env.get('PREFIX')
175 i_n = ienv.Install(user_prefix + '/lib', targets)
177 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
178 ienv.Alias("install", i_n)
180 def __installbin(ienv, targets, name):
181 user_prefix = env.get('PREFIX')
183 i_n = ienv.Install(user_prefix + '/bin', targets)
185 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
186 ienv.Alias("install", i_n)
188 def __append_target(ienv, target):
189 env.AppendUnique(TS = [target])
191 def __print_targets(env):
193 ===============================================================================
195 for t in env.get('TS'):
198 \nDefault all targets will be built. You can specify the target to build:
200 $ scons [options] [target]
201 ===============================================================================
204 env.AddMethod(__set_dir, 'SetDir')
205 env.AddMethod(__print_targets, 'PrintTargets')
206 env.AddMethod(__src_to_obj, 'SrcToObj')
207 env.AddMethod(__append_target, 'AppendTarget')
208 env.AddMethod(__install, 'InstallTarget')
209 env.AddMethod(__installlib, 'UserInstallTargetLib')
210 env.AddMethod(__installbin, 'UserInstallTargetBin')
211 env.SetDir(env.GetLaunchDir())
212 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
216 ######################################################################
217 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
218 ######################################################################
219 if target_os == "yocto":
221 This code injects Yocto cross-compilation tools+flags into scons'
222 build environment in order to invoke the relevant tools while
227 CC = os.environ['CC']
228 target_prefix = CC.split()[0]
229 target_prefix = target_prefix[:len(target_prefix)-3]
230 tools = {"CC" : target_prefix+"gcc",
231 "CXX" : target_prefix+"g++",
232 "AS" : target_prefix+"as",
233 "LD" : target_prefix+"ld",
234 "GDB" : target_prefix+"gdb",
235 "STRIP" : target_prefix+"strip",
236 "RANLIB" : target_prefix+"ranlib",
237 "OBJCOPY" : target_prefix+"objcopy",
238 "OBJDUMP" : target_prefix+"objdump",
239 "AR" : target_prefix+"ar",
240 "NM" : target_prefix+"nm",
242 "STRINGS": target_prefix+"strings"}
243 PATH = os.environ['PATH'].split(os.pathsep)
245 if tool in os.environ:
247 if os.path.isfile(os.path.join(path, tools[tool])):
248 env[tool] = os.path.join(path, os.environ[tool])
250 env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
252 print "ERROR in Yocto cross-toolchain environment"
255 Now reset TARGET_OS to linux so that all linux specific build configurations
256 hereupon apply for the entirety of the build process.
258 env['TARGET_OS'] = 'linux'
260 We want to preserve debug symbols to allow BitBake to generate both DEBUG and
261 RELEASE packages for OIC.
263 env.AppendUnique(CCFLAGS = ['-g'])
265 Additional flags to pass to the Yocto toolchain.
267 if env.get('RELEASE'):
268 env.AppendUnique(CPPDEFINES = ['NDEBUG'])
269 if env.get('LOGGING'):
270 env.AppendUnique(CPPDEFINES = ['TB_LOG'])
271 env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
272 env.AppendUnique(CFLAGS = ['-std=gnu99'])
273 env.AppendUnique(CCFLAGS = ['-Wall', '-fPIC'])
274 env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
278 If target_os is not Yocto, continue with the regular build process
280 # Load config of target os
281 if target_os in ['linux', 'tizen']:
282 env.SConscript('linux/SConscript')
284 env.SConscript(target_os + '/SConscript')
286 # Delete the temp files of configuration
287 if env.GetOption('clean'):
288 dir = env.get('SRC_DIR')
290 if os.path.exists(dir + '/config.log'):
291 Execute(Delete(dir + '/config.log'))
292 Execute(Delete(dir + '/.sconsign.dblite'))
293 Execute(Delete(dir + '/.sconf_temp'))