Merge branch 'master' into cloud-interface
[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']
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', 'NFC']))
92 else:
93         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'NFC']))
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 #ES_TARGET_ENROLLEE is for specifying what is our target enrollee (Arduino or rest of platforms which support Multicast)
108 help_vars.Add(EnumVariable('ES_TARGET_ENROLLEE', 'Target Enrollee', 'arduino', allowed_values=('arduino', 'tizen', 'linux')))
109 #ES_ROLE is for specifying the role (Enrollee or Mediator) for which scons is being executed
110 help_vars.Add(EnumVariable('ES_ROLE', 'Target build mode', 'mediator', allowed_values=('mediator', 'enrollee')))
111 #ES_SOFT_MODE is for specifying MODE (Mode 1 : Enrollee with  Soft AP or Mode 2  : Mediator with Soft AP)
112 help_vars.Add(EnumVariable('ES_SOFTAP_MODE', 'Target build mode', 'ENROLLEE_SOFTAP', allowed_values=('ENROLLEE_SOFTAP', 'MEDIATOR_SOFTAP')))
113
114 AddOption('--prefix',
115                   dest='prefix',
116                   type='string',
117                   nargs=1,
118                   action='store',
119                   metavar='DIR',
120                   help='installation prefix')
121
122 ######################################################################
123 # Platform(build target) specific options: SDK/NDK & toolchain
124 ######################################################################
125 targets_support_cc = ['linux', 'arduino', 'tizen']
126
127 if target_os in targets_support_cc:
128         # Set cross compile toolchain
129         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
130         help_vars.Add(PathVariable('TC_PATH',
131                         'Toolchain path (Generally only be required for cross-compiling)',
132                         os.environ.get('TC_PATH')))
133
134 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
135         env = Environment(variables = help_vars,
136                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
137                         )
138 else:
139         env = Environment(variables = help_vars, tools = ['default', 'textfile'],
140                         TARGET_ARCH = target_arch, TARGET_OS = target_os,
141                         PREFIX = GetOption('prefix'),
142                         LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR') #for 64bit build
143                         )
144 Help(help_vars.GenerateHelpText(env))
145
146 tc_set_msg = '''
147 ************************************ Warning **********************************
148 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
149 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
150 * cause inexplicable errors.                                                  *
151 *******************************************************************************
152 '''
153 if env.get('VERBOSE') == False:
154         env['CCCOMSTR'] = "Compiling $TARGET"
155         env['SHCCCOMSTR'] = "Compiling $TARGET"
156         env['CXXCOMSTR'] = "Compiling $TARGET"
157         env['SHCXXCOMSTR'] = "Compiling $TARGET"
158         env['LINKCOMSTR'] = "Linking $TARGET"
159         env['SHLINKCOMSTR'] = "Linking $TARGET"
160         env['ARCOMSTR'] = "Archiving $TARGET"
161         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
162
163 if target_os in targets_support_cc:
164         prefix = env.get('TC_PREFIX')
165         tc_path = env.get('TC_PATH')
166         if prefix:
167                 env.Replace(CC = prefix + env.get('CC', 'gcc'))
168                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
169                 env.Replace(AR = prefix + env.get('AR', 'ar'))
170                 env.Replace(AS = prefix + env.get('AS', 'as'))
171                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
172
173         if tc_path:
174                 env.PrependENVPath('PATH', tc_path)
175                 sys_root = os.path.abspath(tc_path + '/../')
176                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
177                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
178
179         if prefix or tc_path:
180                 print tc_set_msg
181
182 # Ensure scons be able to change its working directory
183 env.SConscriptChdir(1)
184
185 # Set the source directory and build directory
186 #   Source directory: 'dir'
187 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
188 #
189 # You can get the directory as following:
190 #   env.get('SRC_DIR')
191 #   env.get('BUILD_DIR')
192
193 def __set_dir(env, dir):
194         if not os.path.exists(dir + '/SConstruct'):
195                 print '''
196 *************************************** Error *********************************
197 * The directory(%s) seems isn't a source code directory, no SConstruct file is
198 * found. *
199 *******************************************************************************
200 ''' % dir
201                 Exit(1)
202
203         if env.get('RELEASE'):
204                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
205         else:
206                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
207         env.VariantDir(build_dir, dir, duplicate=0)
208
209         env.Replace(BUILD_DIR = build_dir)
210         env.Replace(SRC_DIR = dir)
211
212 def __src_to_obj(env, src, home = ''):
213         obj = env.get('BUILD_DIR') + src.replace(home, '')
214         if env.get('OBJSUFFIX'):
215                 obj += env.get('OBJSUFFIX')
216         return env.Object(obj, src)
217
218 def __install(ienv, targets, name):
219         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
220         Alias(name, i_n)
221         env.AppendUnique(TS = [name])
222
223 def __installlib(ienv, targets, name):
224         user_prefix = env.get('PREFIX')
225         if user_prefix:
226                 user_lib = env.get('LIB_INSTALL_DIR')
227                 if user_lib:
228                         i_n = ienv.Install(user_lib, targets)
229                 else:
230                         i_n = ienv.Install(user_prefix + '/lib', targets)
231                 ienv.Alias("install", i_n)
232
233 def __installbin(ienv, targets, name):
234         user_prefix = env.get('PREFIX')
235         if user_prefix:
236                 i_n = ienv.Install(user_prefix + '/bin', targets)
237                 ienv.Alias("install", i_n)
238
239 def __installheader(ienv, targets, dir, name):
240         user_prefix = env.get('PREFIX')
241         if user_prefix:
242                 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
243                 ienv.Alias("install", i_n)
244
245 def __installpcfile(ienv, targets, name):
246         user_prefix = env.get('PREFIX')
247         if user_prefix:
248                 user_lib = env.get('LIB_INSTALL_DIR')
249                 if user_lib:
250                         i_n = ienv.Install(user_lib + '/pkgconfig', targets)
251                 else:
252                         i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
253                 ienv.Alias("install", i_n)
254
255 def __append_target(ienv, name, targets = None):
256         if targets:
257                 env.Alias(name, targets)
258         env.AppendUnique(TS = [name])
259
260 def __print_targets(env):
261         Help('''
262 ===============================================================================
263 Targets:\n    ''')
264         for t in env.get('TS'):
265                 Help(t + ' ')
266         Help('''
267 \nDefault all targets will be built. You can specify the target to build:
268
269     $ scons [options] [target]
270 ===============================================================================
271 ''')
272
273 env.AddMethod(__set_dir, 'SetDir')
274 env.AddMethod(__print_targets, 'PrintTargets')
275 env.AddMethod(__src_to_obj, 'SrcToObj')
276 env.AddMethod(__append_target, 'AppendTarget')
277 env.AddMethod(__install, 'InstallTarget')
278 env.AddMethod(__installlib, 'UserInstallTargetLib')
279 env.AddMethod(__installbin, 'UserInstallTargetBin')
280 env.AddMethod(__installheader, 'UserInstallTargetHeader')
281 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
282 env.SetDir(env.GetLaunchDir())
283 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
284
285 Export('env')
286
287 ######################################################################
288 # Scons to generate the iotivity.pc file from iotivity.pc.in file
289 ######################################################################
290 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
291
292 if env.get('ROUTING') == 'GW':
293         routing_define = 'ROUTING_GATEWAY'
294 elif env.get('ROUTING') == 'EP':
295         routing_define = 'ROUTING_EP'
296
297 user_prefix = env.get('PREFIX')
298 user_lib = env.get('LIB_INSTALL_DIR')
299 if not user_lib:
300         user_lib = '$${prefix}/lib'
301
302 if user_prefix:
303         pc_vars = {'\@PREFIX\@': user_prefix,
304                                 '\@EXEC_PREFIX\@':user_prefix,
305                                 '\@VERSION\@': '1.0.1',
306                                 '\@LIB_INSTALL_DIR\@': user_lib,
307                                 '\@ROUTING_DEFINE\@': routing_define
308                                 }
309 else:
310         pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'),
311                                 '\@EXEC_PREFIX\@': env.get('BUILD_DIR'),
312                                 '\@VERSION\@': '1.0.1',
313                                 '\@LIB_INSTALL_DIR\@': user_lib,
314                                 '\@ROUTING_DEFINE\@': routing_define
315                                 }
316
317 env.Substfile(pc_file, SUBST_DICT = pc_vars)
318
319 ######################################################################
320 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
321 ######################################################################
322 if target_os == "yocto":
323     '''
324     This code injects Yocto cross-compilation tools+flags into scons'
325     build environment in order to invoke the relevant tools while
326     performing a build.
327     '''
328     import os.path
329     try:
330         CC = os.environ['CC']
331         target_prefix = CC.split()[0]
332         target_prefix = target_prefix[:len(target_prefix)-3]
333         tools = {"CC" : target_prefix+"gcc",
334                 "CXX" : target_prefix+"g++",
335                 "AS" : target_prefix+"as",
336                 "LD" : target_prefix+"ld",
337                 "GDB" : target_prefix+"gdb",
338                 "STRIP" : target_prefix+"strip",
339                 "RANLIB" : target_prefix+"ranlib",
340                 "OBJCOPY" : target_prefix+"objcopy",
341                 "OBJDUMP" : target_prefix+"objdump",
342                 "AR" : target_prefix+"ar",
343                 "NM" : target_prefix+"nm",
344                 "M4" : "m4",
345                 "STRINGS": target_prefix+"strings"}
346         PATH = os.environ['PATH'].split(os.pathsep)
347         for tool in tools:
348             if tool in os.environ:
349                 for path in PATH:
350                     if os.path.isfile(os.path.join(path, tools[tool])):
351                         env[tool] = os.path.join(path, os.environ[tool])
352                         break
353         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
354     except:
355         print "ERROR in Yocto cross-toolchain environment"
356         Exit(1)
357     '''
358     Now reset TARGET_OS to linux so that all linux specific build configurations
359     hereupon apply for the entirety of the build process.
360     '''
361     env['TARGET_OS'] = 'linux'
362     '''
363     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
364     RELEASE packages for OIC.
365     '''
366     env.AppendUnique(CCFLAGS = ['-g'])
367     '''
368     Additional flags to pass to the Yocto toolchain.
369     '''
370     if env.get('RELEASE'):
371         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
372     if env.get('LOGGING'):
373         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
374     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
375     env.AppendUnique(CFLAGS = ['-std=gnu99'])
376     env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
377     env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
378     env.AppendUnique(LIBS = ['uuid'])
379     Export('env')
380 else:
381     '''
382     If target_os is not Yocto, continue with the regular build process
383     '''
384     # Load config of target os
385     env.SConscript(target_os + '/SConscript')
386
387 # Delete the temp files of configuration
388 if env.GetOption('clean'):
389         dir = env.get('SRC_DIR')
390
391         if os.path.exists(dir + '/config.log'):
392                 Execute(Delete(dir + '/config.log'))
393         if os.path.exists(dir + '/.sconsign.dblite'):
394                 Execute(Delete(dir + '/.sconsign.dblite'))
395         if os.path.exists(dir + '/.sconf_temp'):
396                 Execute(Delete(dir + '/.sconf_temp'))
397
398 ######################################################################
399 # Check for PThreads support
400 ######################################################################
401 import iotivityconfig
402 from iotivityconfig import *
403
404 conf = Configure(env,
405         custom_tests =
406         {
407             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
408         } )
409
410 # Identify whether we have pthreads support, which is necessary for
411 # threading and mutexes.  This will set the environment variable
412 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
413 conf.CheckPThreadsSupport()
414
415 env = conf.Finish()
416 ######################################################################
417
418 env.SConscript('external_libs.scons')
419 Return('env')