15f97de2618dc4ec758e567e731517ce6f5d4bb0
[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'],
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': ['x86', 'x86_64'],
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 ######################################################################
54 # Common build options (release, target os, target arch)
55 ######################################################################
56 targets_disallow_multitransport = ['arduino']
57
58 help_vars = Variables()
59 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
60 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
61
62 if target_os in targets_disallow_multitransport:
63     help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ETHERNET', ['WIFI', 'BT', 'BLE', 'ETHERNET']))
64 else:
65     help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'WIFI', 'BT', 'BLE', 'ETHERNET']))
66
67 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
68 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
69 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
70 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
71 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
72 ######################################################################
73 # Platform(build target) specific options: SDK/NDK & toolchain
74 ######################################################################
75 targets_support_cc = ['linux', 'arduino', 'tizen']
76
77 if target_os in targets_support_cc:
78         # Set cross compile toolchain
79         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
80         help_vars.Add(PathVariable('TC_PATH',
81                         'Toolchain path (Generally only be required for cross-compiling)',
82                         os.environ.get('TC_PATH')))
83
84 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
85         env = Environment(variables = help_vars,
86                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as']
87                         )
88 else:
89         env = Environment(variables = help_vars, TARGET_ARCH = target_arch, TARGET_OS = target_os)
90
91 Help(help_vars.GenerateHelpText(env))
92
93 tc_set_msg = '''
94 ************************************ Warning **********************************
95 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
96 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
97 * cause inexplicable errors.                                                  *
98 *******************************************************************************
99 '''
100
101 if target_os in targets_support_cc:
102         prefix = env.get('TC_PREFIX')
103         tc_path = env.get('TC_PATH')
104         if prefix:
105                 env.Replace(CC = prefix + 'gcc')
106                 env.Replace(CXX = prefix + 'g++')
107                 env.Replace(AR = prefix + 'ar')
108                 env.Replace(AS = prefix + 'as')
109                 env.Replace(LINK = prefix + 'ld')
110                 env.Replace(RANLIB = prefix + 'ranlib')
111
112         if tc_path:
113                 env.PrependENVPath('PATH', tc_path)
114                 sys_root = os.path.abspath(tc_path + '/../')
115                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
116                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
117
118         if prefix or tc_path:
119                 print tc_set_msg
120
121 # Ensure scons be able to change its working directory
122 env.SConscriptChdir(1)
123
124 # Set the source directory and build directory
125 #   Source directory: 'dir'
126 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
127 #
128 # You can get the directory as following:
129 #   env.get('SRC_DIR')
130 #   env.get('BUILD_DIR')
131
132 def __set_dir(env, dir):
133         if not os.path.exists(dir + '/SConstruct'):
134                 print '''
135 *************************************** Error *********************************
136 * The directory(%s) seems isn't a source code directory, no SConstruct file is
137 * found. *
138 *******************************************************************************
139 ''' % dir
140                 Exit(1)
141
142         if env.get('RELEASE'):
143                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
144         else:
145                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
146         env.VariantDir(build_dir, dir, duplicate=0)
147
148         env.Replace(BUILD_DIR = build_dir)
149         env.Replace(SRC_DIR = dir)
150
151 def __src_to_obj(env, src, home = ''):
152         obj = env.get('BUILD_DIR') + src.replace(home, '')
153         if env.get('OBJSUFFIX'):
154                 obj += env.get('OBJSUFFIX')
155         return env.Object(obj, src)
156
157 def __install(ienv, targets, name):
158         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
159         Alias(name, i_n)
160         env.AppendUnique(TS = [name])
161
162 def __append_target(ienv, target):
163         env.AppendUnique(TS = [target])
164
165 def __print_targets(env):
166         Help('''
167 ===============================================================================
168 Targets:\n    ''')
169         for t in env.get('TS'):
170                 Help(t + ' ')
171         Help('''
172 \nDefault all targets will be built. You can specify the target to build:
173
174     $ scons [options] [target]
175 ===============================================================================
176 ''')
177
178 env.AddMethod(__set_dir, 'SetDir')
179 env.AddMethod(__print_targets, 'PrintTargets')
180 env.AddMethod(__src_to_obj, 'SrcToObj')
181 env.AddMethod(__append_target, 'AppendTarget')
182 env.AddMethod(__install, 'InstallTarget')
183 env.SetDir(env.GetLaunchDir())
184 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
185
186 Export('env')
187
188 ######################################################################
189 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
190 ######################################################################
191 if target_os == "yocto":
192     '''
193     This code injects Yocto cross-compilation tools+flags into scons' 
194     build environment in order to invoke the relevant tools while 
195     performing a build.
196     '''
197     import os.path
198     try:
199         CC = os.environ['CC']
200         target_prefix = CC.split()[0]
201         target_prefix = target_prefix[:len(target_prefix)-3]
202         tools = {"CC" : target_prefix+"gcc",
203                 "CXX" : target_prefix+"g++",
204                 "AS" : target_prefix+"as",
205                 "LD" : target_prefix+"ld",
206                 "GDB" : target_prefix+"gdb",
207                 "STRIP" : target_prefix+"strip",
208                 "RANLIB" : target_prefix+"ranlib",
209                 "OBJCOPY" : target_prefix+"objcopy",
210                 "OBJDUMP" : target_prefix+"objdump",
211                 "AR" : target_prefix+"ar",
212                 "NM" : target_prefix+"nm",
213                 "M4" : "m4",
214                 "STRINGS": target_prefix+"strings"}
215         PATH = os.environ['PATH'].split(os.pathsep)
216         for tool in tools:
217             if tool in os.environ:
218                 for path in PATH:
219                     if os.path.isfile(os.path.join(path, tools[tool])):
220                         env[tool] = os.path.join(path, os.environ[tool])
221                         break
222     except:
223         print "ERROR in Yocto cross-toolchain environment"
224         Exit(1)
225     '''
226     Now reset TARGET_OS to linux so that all linux specific build configurations
227     hereupon apply for the entirety of the build process.
228     '''
229     env['TARGET_OS'] = 'linux'
230     '''
231     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
232     RELEASE packages for OIC. 
233     '''
234     env['CCFLAGS'].append('-g')
235     Export('env')
236 else:
237     '''
238     If target_os is not Yocto, continue with the regular build process
239     '''
240     # Load config of target os
241     if target_os in ['linux', 'tizen']:
242                 env.SConscript('linux/SConscript')
243     else:
244                 env.SConscript(target_os + '/SConscript')
245
246 env.SConscript('external_libs.scons')
247
248 # Delete the temp files of configuration
249 if env.GetOption('clean'):
250         dir = env.get('SRC_DIR')
251
252         if os.path.exists(dir + '/config.log'):
253                 Execute(Delete(dir + '/config.log'))
254                 Execute(Delete(dir + '/.sconsign.dblite'))
255                 Execute(Delete(dir + '/.sconf_temp'))
256
257 Return('env')