Merge branch 'master' into easysetup
[platform/upstream/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 if target_os == 'android':
44         default_arch = 'x86'
45 else:
46         default_arch = platform.machine()
47
48 if default_arch not in os_arch_map[target_os]:
49         default_arch = os_arch_map[target_os][0].lower()
50
51 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
52
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)
56
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")
59
60 if ARGUMENTS.get('TEST'):
61         logging_default = False
62 else:
63         release_mode = False
64         if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
65                 release_mode = True
66         logging_default = (release_mode == False)
67
68
69
70 ######################################################################
71 # Common build options (release, target os, target arch)
72 ######################################################################
73 targets_disallow_multitransport = ['arduino', 'android']
74
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]))
79
80
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
85 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
86
87 help_vars.Add(BoolVariable('WITH_RA_IBB', 'Build with Remote Access module(workssys)', False))
88
89
90 if target_os in targets_disallow_multitransport:
91         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP']))
92 else:
93         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP']))
94
95 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
96 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
97 help_vars.Add(EnumVariable('DTLS_WITH_X509', 'DTLS with X.509 support', '0', allowed_values=('0', '1')))
98 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
99 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
100 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
101 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
102 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
103 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
104 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
105 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
106 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
107
108 AddOption('--prefix',
109                   dest='prefix',
110                   type='string',
111                   nargs=1,
112                   action='store',
113                   metavar='DIR',
114                   help='installation prefix')
115
116 ######################################################################
117 # Platform(build target) specific options: SDK/NDK & toolchain
118 ######################################################################
119 targets_support_cc = ['linux', 'arduino', 'tizen']
120
121 if target_os in targets_support_cc:
122         # Set cross compile toolchain
123         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
124         help_vars.Add(PathVariable('TC_PATH',
125                         'Toolchain path (Generally only be required for cross-compiling)',
126                         os.environ.get('TC_PATH')))
127
128 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
129         env = Environment(variables = help_vars,
130                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
131                         )
132 else:
133         env = Environment(variables = help_vars, tools = ['default', 'textfile'], TARGET_ARCH = target_arch, TARGET_OS = target_os, PREFIX = GetOption('prefix'))
134
135 Help(help_vars.GenerateHelpText(env))
136
137 tc_set_msg = '''
138 ************************************ Warning **********************************
139 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
140 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
141 * cause inexplicable errors.                                                  *
142 *******************************************************************************
143 '''
144 if env.get('VERBOSE') == False:
145         env['CCCOMSTR'] = "Compiling $TARGET"
146         env['SHCCCOMSTR'] = "Compiling $TARGET"
147         env['CXXCOMSTR'] = "Compiling $TARGET"
148         env['SHCXXCOMSTR'] = "Compiling $TARGET"
149         env['LINKCOMSTR'] = "Linking $TARGET"
150         env['SHLINKCOMSTR'] = "Linking $TARGET"
151         env['ARCOMSTR'] = "Archiving $TARGET"
152         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
153
154 if target_os in targets_support_cc:
155         prefix = env.get('TC_PREFIX')
156         tc_path = env.get('TC_PATH')
157         if prefix:
158                 env.Replace(CC = prefix + env.get('CC', 'gcc'))
159                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
160                 env.Replace(AR = prefix + env.get('AR', 'ar'))
161                 env.Replace(AS = prefix + env.get('AS', 'as'))
162                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
163
164         if tc_path:
165                 env.PrependENVPath('PATH', tc_path)
166                 sys_root = os.path.abspath(tc_path + '/../')
167                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
168                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
169
170         if prefix or tc_path:
171                 print tc_set_msg
172
173 # Ensure scons be able to change its working directory
174 env.SConscriptChdir(1)
175
176 # Set the source directory and build directory
177 #   Source directory: 'dir'
178 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
179 #
180 # You can get the directory as following:
181 #   env.get('SRC_DIR')
182 #   env.get('BUILD_DIR')
183
184 def __set_dir(env, dir):
185         if not os.path.exists(dir + '/SConstruct'):
186                 print '''
187 *************************************** Error *********************************
188 * The directory(%s) seems isn't a source code directory, no SConstruct file is
189 * found. *
190 *******************************************************************************
191 ''' % dir
192                 Exit(1)
193
194         if env.get('RELEASE'):
195                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
196         else:
197                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
198         env.VariantDir(build_dir, dir, duplicate=0)
199
200         env.Replace(BUILD_DIR = build_dir)
201         env.Replace(SRC_DIR = dir)
202
203 def __src_to_obj(env, src, home = ''):
204         obj = env.get('BUILD_DIR') + src.replace(home, '')
205         if env.get('OBJSUFFIX'):
206                 obj += env.get('OBJSUFFIX')
207         return env.Object(obj, src)
208
209 def __install(ienv, targets, name):
210         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
211         Alias(name, i_n)
212         env.AppendUnique(TS = [name])
213
214 def __installlib(ienv, targets, name):
215         user_prefix = env.get('PREFIX')
216         if user_prefix:
217                 i_n = ienv.Install(user_prefix + '/lib', targets)
218         else:
219                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
220         ienv.Alias("install", i_n)
221
222 def __installbin(ienv, targets, name):
223         user_prefix = env.get('PREFIX')
224         if user_prefix:
225                 i_n = ienv.Install(user_prefix + '/bin', targets)
226         else:
227                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
228         ienv.Alias("install", i_n)
229
230 def __installheader(ienv, targets, dir, name):
231         user_prefix = env.get('PREFIX')
232         if user_prefix:
233                 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
234         else:
235                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
236         ienv.Alias("install", i_n)
237
238 def __installpcfile(ienv, targets, name):
239         user_prefix = env.get('PREFIX')
240         if user_prefix:
241                 i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
242         else:
243                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
244         ienv.Alias("install", i_n)
245
246 def __append_target(ienv, name, targets = None):
247         if targets:
248                 env.Alias(name, targets)
249         env.AppendUnique(TS = [name])
250
251 def __print_targets(env):
252         Help('''
253 ===============================================================================
254 Targets:\n    ''')
255         for t in env.get('TS'):
256                 Help(t + ' ')
257         Help('''
258 \nDefault all targets will be built. You can specify the target to build:
259
260     $ scons [options] [target]
261 ===============================================================================
262 ''')
263
264 env.AddMethod(__set_dir, 'SetDir')
265 env.AddMethod(__print_targets, 'PrintTargets')
266 env.AddMethod(__src_to_obj, 'SrcToObj')
267 env.AddMethod(__append_target, 'AppendTarget')
268 env.AddMethod(__install, 'InstallTarget')
269 env.AddMethod(__installlib, 'UserInstallTargetLib')
270 env.AddMethod(__installbin, 'UserInstallTargetBin')
271 env.AddMethod(__installheader, 'UserInstallTargetHeader')
272 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
273 env.SetDir(env.GetLaunchDir())
274 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
275
276 Export('env')
277
278 ######################################################################
279 # Scons to generate the iotivity.pc file from iotivity.pc.in file
280 ######################################################################
281 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
282
283 user_prefix = env.get('PREFIX')
284
285 if user_prefix:
286         pc_vars = {'\@PREFIX\@': user_prefix, '\@EXEC_PREFIX\@':user_prefix, '\@VERSION\@':'0.9.2'}
287 else:
288         pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'), '\@EXEC_PREFIX\@': env.get('BUILD_DIR'), '\@VERSION\@':'0.9.2'}
289
290 env.Substfile(pc_file, SUBST_DICT = pc_vars)
291
292 ######################################################################
293 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
294 ######################################################################
295 if target_os == "yocto":
296     '''
297     This code injects Yocto cross-compilation tools+flags into scons'
298     build environment in order to invoke the relevant tools while
299     performing a build.
300     '''
301     import os.path
302     try:
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",
317                 "M4" : "m4",
318                 "STRINGS": target_prefix+"strings"}
319         PATH = os.environ['PATH'].split(os.pathsep)
320         for tool in tools:
321             if tool in os.environ:
322                 for path in PATH:
323                     if os.path.isfile(os.path.join(path, tools[tool])):
324                         env[tool] = os.path.join(path, os.environ[tool])
325                         break
326         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
327     except:
328         print "ERROR in Yocto cross-toolchain environment"
329         Exit(1)
330     '''
331     Now reset TARGET_OS to linux so that all linux specific build configurations
332     hereupon apply for the entirety of the build process.
333     '''
334     env['TARGET_OS'] = 'linux'
335     '''
336     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
337     RELEASE packages for OIC.
338     '''
339     env.AppendUnique(CCFLAGS = ['-g'])
340     '''
341     Additional flags to pass to the Yocto toolchain.
342     '''
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'])
352     Export('env')
353 else:
354     '''
355     If target_os is not Yocto, continue with the regular build process
356     '''
357     # Load config of target os
358     env.SConscript(target_os + '/SConscript')
359
360 # Delete the temp files of configuration
361 if env.GetOption('clean'):
362         dir = env.get('SRC_DIR')
363
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'))
370
371 ######################################################################
372 # Check for PThreads support
373 ######################################################################
374 import iotivityconfig
375 from iotivityconfig import *
376
377 conf = Configure(env,
378         custom_tests =
379         {
380             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
381         } )
382
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()
387
388 env = conf.Finish()
389 ######################################################################
390
391 env.SConscript('external_libs.scons')
392 Return('env')