f02da232d7cdcd0f6c88cea217d9ff0b2e0e7b91
[platform/upstream/iotivity.git] / build_common / SConscript
1 # -*- mode: python; python-indent-offset: 4; indent-tabs-mode: nil -*-
2 ##
3 # This script includes generic build options:
4 #    release/debug, target os, target arch, cross toolchain, build environment etc
5 ##
6 import os
7 import platform
8
9 project_version = '1.2.1'
10
11 # Map of host os and allowed target os (host: allowed target os)
12 host_target_map = {
13                 'linux': ['linux', 'android', 'arduino', 'yocto', 'tizen', 'tizenrt'],
14                 'windows': ['windows', 'android', 'arduino'],
15                 'darwin': ['darwin', 'ios', 'android', 'arduino'],
16                 'msys_nt' :['msys_nt'],
17                 }
18
19 # Map of os and allowed archs (os: allowed archs)
20 os_arch_map = {
21                 'linux': ['x86', 'x86_64', 'arm', 'arm-v7a', 'armeabi-v7a', 'arm64'],
22                 'tizen': ['x86', 'x86_64', 'arm', 'arm-v7a', 'armeabi-v7a', 'arm64'],
23                 'android': ['x86', 'x86_64', 'armeabi', 'armeabi-v7a', 'armeabi-v7a-hard', 'arm64-v8a'],
24                 'windows': ['x86', 'amd64', 'arm'],
25                 'msys_nt':['x86', 'x86_64'],
26                 'darwin': ['i386', 'x86_64'],
27                 'ios': ['i386', 'x86_64', 'armv7', 'armv7s', 'arm64'],
28                 'arduino': ['avr', 'arm'],
29                 'yocto': ['i586', 'i686', 'x86_64', 'arm', 'aarch64', 'powerpc', 'powerpc64', 'mips', 'mipsel'],
30                 'tizenrt': ['armv7-r', 'armv7-m'],
31                 }
32
33 host = platform.system().lower()
34
35 # the host string contains version of windows. 6.3, 6.4, 10.0 which is 8.0, 8.1, and 10 respectively.
36 # Let's canonicalize the msys_nt-XX.X system name by stripping version off.
37 if 'msys_nt' in host:
38         host = 'msys_nt'
39
40 if not host_target_map.has_key(host):
41         print "\nError: Current system (%s) isn't supported\n" % host
42         Exit(1)
43
44 ######################################################################
45 # Get build options (the optins from command line)
46 ######################################################################
47 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
48
49 if target_os not in host_target_map[host]:
50         print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
51         Exit(1)
52
53 if target_os == 'android':
54         default_arch = 'x86'
55 else:
56         default_arch = platform.machine()
57
58 if default_arch not in os_arch_map[target_os]:
59         default_arch = os_arch_map[target_os][0].lower()
60
61 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
62
63 # True if binary needs to be installed on board. (Might need root permissions)
64 # set to 'no', 'false' or 0 for only compilation
65 require_upload = ARGUMENTS.get('UPLOAD', False)
66
67 # Get the device name. This name can be used as network display name wherever possible
68 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
69
70 default_with_upstream_libcoap = 0
71
72 if ARGUMENTS.get('TEST'):
73         logging_default = False
74 else:
75         release_mode = False
76         if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
77                 release_mode = True
78         logging_default = (release_mode == False)
79
80 # targets that do not support the DTLS build (SECURED=1 build option)
81 targets_without_dtls_support = ['arduino'];
82 if ARGUMENTS.get('SECURED') == '1' and target_os in targets_without_dtls_support:
83         print "\nError: DTLS not supported on target os: %s MUST build with SECURED=0\n" % (target_os)
84         Exit(1)
85
86 ######################################################################
87 # Common build options (release, target os, target arch)
88 ######################################################################
89 targets_disallow_multitransport = ['arduino']
90
91 help_vars = Variables()
92 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
93 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
94 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
95
96
97 help_vars.Add(BoolVariable('WITH_RA', 'Build with Remote Access module', False))
98 help_vars.Add(BoolVariable('WITH_TCP', 'Build with TCP adapter', False))
99 help_vars.Add(BoolVariable('DISABLE_TCP_SERVER', 'Disable TCP server', False))
100 help_vars.Add(BoolVariable('WITH_PROXY', 'Build with CoAP-HTTP Proxy', False))
101 help_vars.Add(ListVariable('WITH_MQ', 'Build with MQ publisher/broker', 'OFF', ['OFF', 'SUB', 'PUB', 'BROKER']))
102 help_vars.Add(BoolVariable('WITH_CLOUD', 'Build including AccountManager class and Cloud Client sample', False))
103 help_vars.Add(ListVariable('RD_MODE', 'Resource Directory build mode', 'CLIENT', ['CLIENT', 'SERVER']))
104 help_vars.Add(BoolVariable('DISABLE_PRESENCE', 'Disable Presence Feature', False))
105 help_vars.Add(BoolVariable('DISABLE_BLE_SERVER', 'Disable BLE server', False))
106
107 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
108
109 help_vars.Add(BoolVariable('WITH_RA_IBB', 'Build with Remote Access module(workssys)', False))
110 help_vars.Add(BoolVariable('WITH_ASAN', 'Build with Address Sanitizer support', False))
111
112
113 if target_os in targets_disallow_multitransport:
114         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP', 'NFC']))
115 else:
116         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'NFC']))
117
118 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
119 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
120 help_vars.Add(EnumVariable('WITH_MBEDTLS_STATIC_LIB', 'Build mbedTLS library as static library', '0', allowed_values=('0', '1')))
121 help_vars.Add(EnumVariable('MULTIPLE_OWNER', 'Enable multiple owner', '0', allowed_values=('0', '1')))
122 help_vars.Add(EnumVariable('EXC_PROV_SUPPORT', 'Except OCPMAPI library(libocpmapi.so)', '0', allowed_values=('0', '1')))
123 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
124 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
125 help_vars.Add(EnumVariable('LOG_LEVEL', 'Enable stack logging level', 'DEBUG', allowed_values=('DEBUG', 'INFO', 'ERROR', 'WARNING', 'FATAL')))
126 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
127 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
128 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
129 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
130 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
131 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
132 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
133 help_vars.Add(EnumVariable('WITH_UPSTREAM_LIBCOAP', 'Use latest stable version of LibCoAP downloaded from github', default_with_upstream_libcoap, allowed_values=('0','1')))
134 help_vars.Add(EnumVariable('BLE_CUSTOM_ADV', 'Build with CUSTOM Advertisement', 'False', allowed_values=('True', 'False')))
135 help_vars.Add(EnumVariable('BLE_DIVISION', 'BLE Build with division code', 'OFF', allowed_values=('OFF', 'MCD', 'VD')))
136 help_vars.Add(EnumVariable('BLE_TIZEN_30', 'Build with tizen 3.0 BLE api', 'False', allowed_values=('True', 'False')))
137 help_vars.Add(EnumVariable('TIZEN_4', 'Build with tizen 4.0 api', 'False', allowed_values=('True', 'False')))
138 help_vars.Add(PathVariable('TIZENRT_OS_DIR', 'Absolute Path to TizenRT OS directory', None, PathVariable.PathAccept))
139 help_vars.Add(EnumVariable('PLATFORM_TLS', 'Use platform tls instead of local mbedtls', '0', allowed_values=('0', '1')))
140 help_vars.Add(EnumVariable('OIC_SUPPORT_TIZEN_TRACE', 'Tizen Trace(T-trace) api availability', 'False', allowed_values=('True', 'False')))
141 help_vars.Add(EnumVariable('WITH_PROCESS_EVENT','Build including procee event logics in ocstack', 'False', allowed_values=('True', 'False')))
142 AddOption('--prefix',
143                   dest='prefix',
144                   type='string',
145                   nargs=1,
146                   action='store',
147                   metavar='DIR',
148                   help='installation prefix')
149
150 ######################################################################
151 # Platform(build target) specific options: SDK/NDK & toolchain
152 ######################################################################
153 targets_support_cc = ['linux', 'arduino', 'tizen', 'tizenrt']
154
155 if target_os in targets_support_cc:
156         # Set cross compile toolchain
157         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
158         help_vars.Add(PathVariable('TC_PATH',
159                         'Toolchain path (Generally only be required for cross-compiling)',
160                         os.environ.get('TC_PATH')))
161
162 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
163         env = Environment(variables = help_vars,
164                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
165                         )
166 else:
167         env = Environment(variables = help_vars, tools = ['default', 'textfile'],
168                         TARGET_ARCH = target_arch, TARGET_OS = target_os,
169                         PREFIX = GetOption('prefix'),
170                         LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR') #for 64bit build
171                         )
172 Help(help_vars.GenerateHelpText(env))
173
174 tc_set_msg = '''
175 ************************************ Warning **********************************
176 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
177 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
178 * cause inexplicable errors.                                                  *
179 *******************************************************************************
180 '''
181 if env.get('VERBOSE') == False:
182         env['CCCOMSTR'] = "Compiling $TARGET"
183         env['SHCCCOMSTR'] = "Compiling $TARGET"
184         env['CXXCOMSTR'] = "Compiling $TARGET"
185         env['SHCXXCOMSTR'] = "Compiling $TARGET"
186         env['LINKCOMSTR'] = "Linking $TARGET"
187         env['SHLINKCOMSTR'] = "Linking $TARGET"
188         env['ARCOMSTR'] = "Archiving $TARGET"
189         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
190
191 if target_os in targets_support_cc:
192         prefix = env.get('TC_PREFIX')
193         tc_path = env.get('TC_PATH')
194         if prefix:
195                 env.Replace(CC = prefix + env.get('CC', 'gcc'))
196                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
197                 env.Replace(AR = prefix + env.get('AR', 'ar'))
198                 env.Replace(AS = prefix + env.get('AS', 'as'))
199                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
200
201         if tc_path:
202                 env.PrependENVPath('PATH', tc_path)
203                 sys_root = os.path.abspath(tc_path + '/../')
204                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
205                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
206
207         if target_os == 'tizenrt':
208                 env.PrependENVPath('PATH', os.environ['PATH'])
209
210         if prefix or tc_path:
211                 print tc_set_msg
212
213 # If cross-compiling, honor environment settings for toolchain to avoid picking up native tools
214 if os.environ.get('PKG_CONFIG') != None:
215         env["ENV"]["PKG_CONFIG"] = os.environ.get("PKG_CONFIG")
216 if os.environ.get('PKG_CONFIG_PATH') != None:
217         env["ENV"]["PKG_CONFIG_PATH"] = os.environ.get("PKG_CONFIG_PATH")
218 if os.environ.get('PKG_CONFIG_SYSROOT_DIR') != None:
219         env["ENV"]["PKG_CONFIG_SYSROOT_DIR"] = os.environ.get("PKG_CONFIG_SYSROOT_DIR")
220
221 # Ensure scons be able to change its working directory
222 env.SConscriptChdir(1)
223
224 # Set the source directory and build directory
225 #   Source directory: 'dir'
226 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
227 #
228 # You can get the directory as following:
229 #   env.get('SRC_DIR')
230 #   env.get('BUILD_DIR')
231
232 def __set_dir(env, dir):
233         if not os.path.exists(dir + '/SConstruct'):
234                 print '''
235 *************************************** Error *********************************
236 * The directory(%s) seems isn't a source code directory, no SConstruct file is
237 * found. *
238 *******************************************************************************
239 ''' % dir
240                 Exit(1)
241
242         if env.get('RELEASE'):
243                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
244         else:
245                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
246         env.VariantDir(build_dir, dir, duplicate=0)
247
248         env.Replace(BUILD_DIR = build_dir)
249         env.Replace(SRC_DIR = dir)
250
251 def __src_to_obj(env, src, home = ''):
252         obj = env.get('BUILD_DIR') + src.replace(home, '')
253         if env.get('OBJSUFFIX'):
254                 obj += env.get('OBJSUFFIX')
255         return env.Object(obj, src)
256
257 def __install(ienv, targets, name):
258         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
259         Alias(name, i_n)
260         env.AppendUnique(TS = [name])
261
262 def __installlib(ienv, targets, name):
263         user_prefix = env.get('PREFIX')
264         if user_prefix:
265                 user_lib = env.get('LIB_INSTALL_DIR')
266                 if user_lib:
267                         i_n = ienv.Install(user_lib, targets)
268                 else:
269                         i_n = ienv.Install(user_prefix + '/lib', targets)
270                 ienv.Alias("install", i_n)
271         else:
272                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
273         ienv.Alias("install", i_n)
274
275 def __installbin(ienv, targets, name):
276         user_prefix = env.get('PREFIX')
277         if user_prefix:
278                 i_n = ienv.Install(user_prefix + '/bin', targets)
279                 ienv.Alias("install", i_n)
280
281 def __installheader(ienv, targets, dir, name):
282         user_prefix = env.get('PREFIX')
283         if user_prefix:
284                 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
285         else:
286                 i_n = ienv.Install(os.path.join(env.get('BUILD_DIR'), 'include', dir), targets)
287         ienv.Alias("install", i_n)
288
289 def __installpcfile(ienv, targets, name):
290         user_prefix = env.get('PREFIX')
291         if user_prefix:
292                 user_lib = env.get('LIB_INSTALL_DIR')
293                 if user_lib:
294                         i_n = ienv.Install(user_lib + '/pkgconfig', targets)
295                 else:
296                         i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
297         else:
298                 i_n = ienv.Install(env.get('BUILD_DIR') + 'lib/pkgconfig', targets)
299         ienv.Alias("install", i_n)
300
301 def __append_target(ienv, name, targets = None):
302         if targets:
303                 env.Alias(name, targets)
304         env.AppendUnique(TS = [name])
305
306 def __print_targets(env):
307         Help('''
308 ===============================================================================
309 Targets:\n    ''')
310         for t in env.get('TS'):
311                 Help(t + ' ')
312         Help('''
313 \nDefault all targets will be built. You can specify the target to build:
314
315     $ scons [options] [target]
316 ===============================================================================
317 ''')
318
319 env.AddMethod(__set_dir, 'SetDir')
320 env.AddMethod(__print_targets, 'PrintTargets')
321 env.AddMethod(__src_to_obj, 'SrcToObj')
322 env.AddMethod(__append_target, 'AppendTarget')
323 env.AddMethod(__install, 'InstallTarget')
324 env.AddMethod(__installlib, 'UserInstallTargetLib')
325 env.AddMethod(__installbin, 'UserInstallTargetBin')
326 env.AddMethod(__installheader, 'UserInstallTargetHeader')
327 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
328 env.SetDir(env.GetLaunchDir())
329 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
330
331 Export('env')
332
333 ######################################################################
334 # Scons to generate the iotivity.pc file from iotivity.pc.in file
335 ######################################################################
336 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
337
338 user_prefix = env.get('PREFIX')
339 user_lib = env.get('LIB_INSTALL_DIR')
340
341 if not user_prefix:
342     user_prefix = env.get('BUILD_DIR').encode('string_escape')
343
344 if not user_lib:
345     user_lib = '$${prefix}/lib'
346
347 defines = []
348 if env.get('LOGGING'):
349     defines.append('-DTB_LOG=1')
350
351 if env.get('ROUTING') == 'GW':
352     defines.append('-DROUTING_GATEWAY=1')
353 elif env.get('ROUTING') == 'EP':
354     defines.append('-DROUTING_EP=1')
355
356 if env.get('WITH_TCP'):
357     defines.append('-DTCP_ADAPTER=1')
358     if env.get('SECURED') == '1':
359         defines.append('-D__WITH_TLS__=1')
360
361 if env.get('DISABLE_TCP_SERVER'):
362         defines.append('-DDISABLE_TCP_SERVER=1')
363
364 if env.get('DISABLE_PRESENCE') == False:
365     env.AppendUnique(CPPDEFINES = ['WITH_PRESENCE'])
366
367 if env.get('DISABLE_BLE_SERVER'):
368     defines.append('-DDISABLE_BLE_SERVER=1')
369
370 if env.get('WITH_PROCESS_EVENT'):
371     env.AppendUnique(CPPDEFINES=['WITH_PROCESS_EVENT'])
372
373 libs = []
374 if env.get('SECURED') == '1':
375     defines.append('-D__WITH_DTLS__=1')
376     if env.get('EXC_PROV_SUPPORT') == '0':
377         libs.append('-locpmapi')        # CAPI
378         libs.append('-locprovision')    # C++API
379
380 pc_vars = {
381     '\@VERSION\@': project_version,
382     '\@PREFIX\@': user_prefix,
383     '\@EXEC_PREFIX\@': user_prefix,
384     '\@LIB_INSTALL_DIR\@': user_lib,
385     '\@DEFINES\@': " ".join(defines),
386     '\@LIBS\@': " ".join(libs)
387 }
388
389 env.Substfile(pc_file, SUBST_DICT = pc_vars)
390
391 ######################################################################
392 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
393 ######################################################################
394 if target_os == "yocto":
395     '''
396     This code injects Yocto cross-compilation tools+flags into scons'
397     build environment in order to invoke the relevant tools while
398     performing a build.
399     '''
400     import os.path
401     try:
402         CC = os.environ['CC']
403         target_prefix = CC.split()[0]
404         target_prefix = target_prefix[:len(target_prefix)-3]
405         tools = {"CC" : target_prefix+"gcc",
406                 "CXX" : target_prefix+"g++",
407                 "AS" : target_prefix+"as",
408                 "LD" : target_prefix+"ld",
409                 "GDB" : target_prefix+"gdb",
410                 "STRIP" : target_prefix+"strip",
411                 "RANLIB" : target_prefix+"ranlib",
412                 "OBJCOPY" : target_prefix+"objcopy",
413                 "OBJDUMP" : target_prefix+"objdump",
414                 "AR" : target_prefix+"ar",
415                 "NM" : target_prefix+"nm",
416                 "M4" : "m4",
417                 "STRINGS": target_prefix+"strings"}
418         PATH = os.environ['PATH'].split(os.pathsep)
419         for tool in tools:
420             if tool in os.environ:
421                 for path in PATH:
422                     if os.path.isfile(os.path.join(path, tools[tool])):
423                         env[tool] = os.path.join(path, os.environ[tool])
424                         break
425         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
426         if os.environ['LDFLAGS'] != None:
427             env.AppendUnique(LINKFLAGS = Split(os.environ['LDFLAGS']))
428     except:
429         print "ERROR in Yocto cross-toolchain environment"
430         Exit(1)
431     '''
432     Now reset TARGET_OS to linux so that all linux specific build configurations
433     hereupon apply for the entirety of the build process.
434     '''
435     env['TARGET_OS'] = 'linux'
436     '''
437     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
438     RELEASE packages for OIC.
439     '''
440     env.AppendUnique(CCFLAGS = ['-g'])
441     '''
442     Additional flags to pass to the Yocto toolchain.
443     '''
444     if env.get('RELEASE'):
445         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
446     if env.get('LOGGING'):
447         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
448     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
449     env.AppendUnique(CFLAGS = ['-std=gnu99'])
450     env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
451     env.AppendUnique(LIBS = ['dl', 'pthread', 'uuid'])
452     Export('env')
453 else:
454     '''
455     If target_os is not Yocto, continue with the regular build process
456     '''
457     # Load config of target os
458     env.SConscript(target_os + '/SConscript')
459
460 # Delete the temp files of configuration
461 if env.GetOption('clean'):
462         dir = env.get('SRC_DIR')
463
464         if os.path.exists(dir + '/config.log'):
465                 Execute(Delete(dir + '/config.log'))
466         if os.path.exists(dir + '/.sconsign.dblite'):
467                 Execute(Delete(dir + '/.sconsign.dblite'))
468         if os.path.exists(dir + '/.sconf_temp'):
469                 Execute(Delete(dir + '/.sconf_temp'))
470
471 ######################################################################
472 # Check for PThreads support
473 ######################################################################
474 import iotivityconfig
475 from iotivityconfig import *
476
477 conf = Configure(env,
478         custom_tests =
479         {
480             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
481         } )
482
483 # Identify whether we have pthreads support, which is necessary for
484 # threading and mutexes.  This will set the environment variable
485 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
486 conf.CheckPThreadsSupport()
487
488 env = conf.Finish()
489 ######################################################################
490
491 env.SConscript('external_libs.scons')
492 Return('env')