afe6f5692f30a556f89febe79ccc7a8b8db5b0f6
[iotivity.git] / build_common / SConscript
1 ##
2 # This script includes generic build options:
3 #    release/debug, target os, target arch, cross toolchain, build environment etc
4 ##
5 import os
6 import platform
7
8 # Map of host os and allowed target os (host: allowed target os)
9 host_target_map = {
10                 'linux': ['linux', 'android', 'arduino', 'yocto', 'tizen'],
11                 'windows': ['windows', 'winrt', 'android', 'arduino'],
12                 'darwin': ['darwin', 'ios', 'android', 'arduino'],
13                 }
14
15 # Map of os and allowed archs (os: allowed archs)
16 os_arch_map = {
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'],
21                 'winrt': ['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'],
26                 }
27
28 host = platform.system().lower()
29
30 if not host_target_map.has_key(host):
31         print "\nError: Current system (%s) isn't supported\n" % host
32         Exit(1)
33
34 ######################################################################
35 # Get build options (the optins from command line)
36 ######################################################################
37 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
38
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])
41         Exit(1)
42
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()
46
47 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
48
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', False)
52
53 if ARGUMENTS.get('TEST'):
54         logging_default = False
55 else:
56         logging_default = (ARGUMENTS.get('RELEASE', True) == 'false')
57
58
59
60 ######################################################################
61 # Common build options (release, target os, target arch)
62 ######################################################################
63 targets_disallow_multitransport = ['arduino']
64
65 help_vars = Variables()
66 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
67 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
68 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
69
70 if target_os in targets_disallow_multitransport:
71     help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP']))
72 else:
73     help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP']))
74
75 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
76 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
77 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
78 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
79 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
80 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
81 ######################################################################
82 # Platform(build target) specific options: SDK/NDK & toolchain
83 ######################################################################
84 targets_support_cc = ['linux', 'arduino', 'tizen']
85
86 if target_os in targets_support_cc:
87         # Set cross compile toolchain
88         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
89         help_vars.Add(PathVariable('TC_PATH',
90                         'Toolchain path (Generally only be required for cross-compiling)',
91                         os.environ.get('TC_PATH')))
92
93 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
94         env = Environment(variables = help_vars,
95                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as']
96                         )
97 else:
98         env = Environment(variables = help_vars, TARGET_ARCH = target_arch, TARGET_OS = target_os)
99
100 Help(help_vars.GenerateHelpText(env))
101
102 tc_set_msg = '''
103 ************************************ Warning **********************************
104 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
105 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
106 * cause inexplicable errors.                                                  *
107 *******************************************************************************
108 '''
109 if env.get('VERBOSE') == False:
110         env['CCCOMSTR'] = "Compiling $TARGET"
111         env['CXXCOMSTR'] = "Compiling $TARGET"
112         env['LINKCOMSTR'] = "Linking $TARGET"
113         env['ARCOMSTR'] = "Archiving $TARGET"
114         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
115
116 if target_os in targets_support_cc:
117         prefix = env.get('TC_PREFIX')
118         tc_path = env.get('TC_PATH')
119         if prefix:
120                 env.Replace(CC = prefix + 'gcc')
121                 env.Replace(CXX = prefix + 'g++')
122                 env.Replace(AR = prefix + 'ar')
123                 env.Replace(AS = prefix + 'as')
124                 env.Replace(LINK = prefix + 'ld')
125                 env.Replace(RANLIB = prefix + 'ranlib')
126
127         if tc_path:
128                 env.PrependENVPath('PATH', tc_path)
129                 sys_root = os.path.abspath(tc_path + '/../')
130                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
131                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
132
133         if prefix or tc_path:
134                 print tc_set_msg
135
136 # Ensure scons be able to change its working directory
137 env.SConscriptChdir(1)
138
139 # Set the source directory and build directory
140 #   Source directory: 'dir'
141 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
142 #
143 # You can get the directory as following:
144 #   env.get('SRC_DIR')
145 #   env.get('BUILD_DIR')
146
147 def __set_dir(env, dir):
148         if not os.path.exists(dir + '/SConstruct'):
149                 print '''
150 *************************************** Error *********************************
151 * The directory(%s) seems isn't a source code directory, no SConstruct file is
152 * found. *
153 *******************************************************************************
154 ''' % dir
155                 Exit(1)
156
157         if env.get('RELEASE'):
158                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
159         else:
160                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
161         env.VariantDir(build_dir, dir, duplicate=0)
162
163         env.Replace(BUILD_DIR = build_dir)
164         env.Replace(SRC_DIR = dir)
165
166 def __src_to_obj(env, src, home = ''):
167         obj = env.get('BUILD_DIR') + src.replace(home, '')
168         if env.get('OBJSUFFIX'):
169                 obj += env.get('OBJSUFFIX')
170         return env.Object(obj, src)
171
172 def __install(ienv, targets, name):
173         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
174         Alias(name, i_n)
175         env.AppendUnique(TS = [name])
176
177 def __append_target(ienv, name, targets = None):
178         if targets:
179                 env.Alias(name, targets)
180         env.AppendUnique(TS = [name])
181
182 def __print_targets(env):
183         Help('''
184 ===============================================================================
185 Targets:\n    ''')
186         for t in env.get('TS'):
187                 Help(t + ' ')
188         Help('''
189 \nDefault all targets will be built. You can specify the target to build:
190
191     $ scons [options] [target]
192 ===============================================================================
193 ''')
194
195 env.AddMethod(__set_dir, 'SetDir')
196 env.AddMethod(__print_targets, 'PrintTargets')
197 env.AddMethod(__src_to_obj, 'SrcToObj')
198 env.AddMethod(__append_target, 'AppendTarget')
199 env.AddMethod(__install, 'InstallTarget')
200 env.SetDir(env.GetLaunchDir())
201 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
202
203 Export('env')
204
205 ######################################################################
206 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
207 ######################################################################
208 if target_os == "yocto":
209     '''
210     This code injects Yocto cross-compilation tools+flags into scons'
211     build environment in order to invoke the relevant tools while
212     performing a build.
213     '''
214     import os.path
215     try:
216         CC = os.environ['CC']
217         target_prefix = CC.split()[0]
218         target_prefix = target_prefix[:len(target_prefix)-3]
219         tools = {"CC" : target_prefix+"gcc",
220                 "CXX" : target_prefix+"g++",
221                 "AS" : target_prefix+"as",
222                 "LD" : target_prefix+"ld",
223                 "GDB" : target_prefix+"gdb",
224                 "STRIP" : target_prefix+"strip",
225                 "RANLIB" : target_prefix+"ranlib",
226                 "OBJCOPY" : target_prefix+"objcopy",
227                 "OBJDUMP" : target_prefix+"objdump",
228                 "AR" : target_prefix+"ar",
229                 "NM" : target_prefix+"nm",
230                 "M4" : "m4",
231                 "STRINGS": target_prefix+"strings"}
232         PATH = os.environ['PATH'].split(os.pathsep)
233         for tool in tools:
234             if tool in os.environ:
235                 for path in PATH:
236                     if os.path.isfile(os.path.join(path, tools[tool])):
237                         env[tool] = os.path.join(path, os.environ[tool])
238                         break
239         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
240     except:
241         print "ERROR in Yocto cross-toolchain environment"
242         Exit(1)
243     '''
244     Now reset TARGET_OS to linux so that all linux specific build configurations
245     hereupon apply for the entirety of the build process.
246     '''
247     env['TARGET_OS'] = 'linux'
248     '''
249     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
250     RELEASE packages for OIC.
251     '''
252     env.AppendUnique(CCFLAGS = ['-g'])
253     '''
254     Additional flags to pass to the Yocto toolchain.
255     '''
256     if env.get('RELEASE'):
257         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
258     if env.get('LOGGING'):
259         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
260     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
261     env.AppendUnique(CFLAGS = ['-std=gnu99'])
262     env.AppendUnique(CCFLAGS = ['-Wall', '-fPIC'])
263     env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
264     Export('env')
265 else:
266     '''
267     If target_os is not Yocto, continue with the regular build process
268     '''
269     # Load config of target os
270     if target_os in ['linux', 'tizen']:
271                 env.SConscript('linux/SConscript')
272     else:
273                 env.SConscript(target_os + '/SConscript')
274
275 # Delete the temp files of configuration
276 if env.GetOption('clean'):
277         dir = env.get('SRC_DIR')
278
279         if os.path.exists(dir + '/config.log'):
280                 Execute(Delete(dir + '/config.log'))
281         if os.path.exists(dir + '/.sconsign.dblite'):
282                 Execute(Delete(dir + '/.sconsign.dblite'))
283         if os.path.exists(dir + '/.sconf_temp'):
284                 Execute(Delete(dir + '/.sconf_temp'))
285
286 ######################################################################
287 # Check for PThreads support
288 ######################################################################
289 import iotivityconfig
290 from iotivityconfig import *
291
292 conf = Configure(env,
293         custom_tests =
294         {
295             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
296         } )
297
298 # Identify whether we have pthreads support, which is necessary for
299 # threading and mutexes.  This will set the environment variable
300 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
301 conf.CheckPThreadsSupport()
302
303 env = conf.Finish()
304 ######################################################################
305
306 env.SConscript('external_libs.scons')
307 Return('env')