Merge changes I21ded957,Ia1308e81,If6bccb8e,I6d548404
[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'],
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                 'android': ['x86', 'x86_64', 'armeabi', 'armeabi-v7a', 'armeabi-v7a-hard', 'arm64-v8a'],
19                 'windows': ['x86', 'amd64', 'arm'],
20                 'winrt': ['arm'],
21                 'darwin': ['i386', 'x86_64'],
22                 'ios': ['i386', 'x86_64', 'armv7', 'armv7s', 'arm64'],
23                 'arduino': ['avr', 'arm'],
24                 'yocto': ['x86', 'x86_64'],
25                 }
26
27 host = platform.system().lower()
28
29 if not host_target_map.has_key(host):
30         print "\nError: Current system (%s) isn't supported\n" % host
31         Exit(1)
32
33 ######################################################################
34 # Get build options (the optins from command line)
35 ######################################################################
36 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
37
38 if target_os not in host_target_map[host]:
39         print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
40         Exit(1)
41
42 default_arch = platform.machine()
43 if default_arch not in os_arch_map[target_os]:
44         default_arch = os_arch_map[target_os][0].lower()
45
46 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
47
48 ######################################################################
49 # Common build options (release, target os, target arch)
50 ######################################################################
51 help_vars = Variables()
52 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
53 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
54 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
55
56 ######################################################################
57 # Platform(build target) specific options: SDK/NDK & toolchain
58 ######################################################################
59 targets_support_cc = ['linux', 'arduino']
60
61 if target_os in targets_support_cc:
62         # Set cross compile toolchain
63         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
64         help_vars.Add(PathVariable('TC_PATH',
65                         'Toolchain path (Generally only be required for cross-compiling)',
66                         os.environ.get('TC_PATH')))
67
68 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
69         env = Environment(variables = help_vars,
70                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as']
71                         )
72 else:
73         env = Environment(variables = help_vars, TARGET_ARCH = target_arch, TARGET_OS = target_os)
74
75 Help(help_vars.GenerateHelpText(env))
76
77 tc_set_msg = '''
78 ************************************ Warning **********************************
79 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
80 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
81 * cause inexplicable errors.                                                  *
82 *******************************************************************************
83 '''
84
85 if target_os in targets_support_cc:
86         prefix = env.get('TC_PREFIX')
87         tc_path = env.get('TC_PATH')
88         if prefix:
89                 env.Replace(CC = prefix + 'gcc')
90                 env.Replace(CXX = prefix + 'g++')
91                 env.Replace(AR = prefix + 'ar')
92                 env.Replace(AS = prefix + 'as')
93                 env.Replace(LINK = prefix + 'ld')
94                 env.Replace(RANLIB = prefix + 'ranlib')
95
96         if tc_path:
97                 env.PrependENVPath('PATH', tc_path)
98                 sys_root = os.path.abspath(tc_path + '/../')
99                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
100                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
101
102         if prefix or tc_path:
103                 print tc_set_msg
104
105 # Ensure scons be able to change its working directory
106 env.SConscriptChdir(1)
107
108 # Set the source directory and build directory
109 #   Source directory: 'dir'
110 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
111 #
112 # You can get the directory as following:
113 #   env.get('SRC_DIR')
114 #   env.get('BUILD_DIR')
115
116 def __set_dir(env, dir):
117         if not os.path.exists(dir + '/SConstruct'):
118                 print '''
119 *************************************** Error *********************************
120 * The directory(%s) seems isn't a source code directory, no SConstruct file is
121 * found. *
122 *******************************************************************************
123 ''' % dir
124                 Exit(1)
125
126         if env.get('RELEASE'):
127                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
128         else:
129                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
130         env.VariantDir(build_dir, dir, duplicate=0)
131
132         env.Replace(BUILD_DIR = build_dir)
133         env.Replace(SRC_DIR = dir)
134
135 def __src_to_obj(env, src, home = ''):
136         obj = env.get('BUILD_DIR') + src.replace(home, '')
137         if env.get('OBJSUFFIX'):
138                 obj += env.get('OBJSUFFIX')
139         return env.Object(obj, src)
140
141 def __install(ienv, targets, name):
142         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
143         Alias(name, i_n)
144         env.AppendUnique(TS = [name])
145
146 def __append_target(ienv, target):
147         env.AppendUnique(TS = [target])
148
149 def __print_targets(env):
150         Help('''
151 ===============================================================================
152 Targets:\n    ''')
153         for t in env.get('TS'):
154                 Help(t + ' ')
155         Help('''
156 \nDefault all targets will be built. You can specify the target to build:
157
158     $ scons [options] [target]
159 ===============================================================================
160 ''')
161
162 env.AddMethod(__set_dir, 'SetDir')
163 env.AddMethod(__print_targets, 'PrintTargets')
164 env.AddMethod(__src_to_obj, 'SrcToObj')
165 env.AddMethod(__append_target, 'AppendTarget')
166 env.AddMethod(__install, 'InstallTarget')
167 env.SetDir(env.GetLaunchDir())
168
169 Export('env')
170
171 ######################################################################
172 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
173 ######################################################################
174 if target_os == "yocto":
175     '''
176     This code injects Yocto cross-compilation tools+flags into scons' 
177     build environment in order to invoke the relevant tools while 
178     performing a build.
179     '''
180     import os.path
181     try:
182         CC = os.environ['CC']
183         target_prefix = CC.split()[0]
184         target_prefix = target_prefix[:len(target_prefix)-3]
185         tools = {"CC" : target_prefix+"gcc",
186                 "CXX" : target_prefix+"g++",
187                 "AS" : target_prefix+"as",
188                 "LD" : target_prefix+"ld",
189                 "GDB" : target_prefix+"gdb",
190                 "STRIP" : target_prefix+"strip",
191                 "RANLIB" : target_prefix+"ranlib",
192                 "OBJCOPY" : target_prefix+"objcopy",
193                 "OBJDUMP" : target_prefix+"objdump",
194                 "AR" : target_prefix+"ar",
195                 "NM" : target_prefix+"nm",
196                 "M4" : "m4",
197                 "STRINGS": target_prefix+"strings"}
198         PATH = os.environ['PATH'].split(os.pathsep)
199         for tool in tools:
200             if tool in os.environ:
201                 for path in PATH:
202                     if os.path.isfile(os.path.join(path, tools[tool])):
203                         env[tool] = os.path.join(path, os.environ[tool])
204                         break
205     except:
206         print "ERROR in Yocto cross-toolchain environment"
207         Exit(1)
208     '''
209     Now reset TARGET_OS to linux so that all linux specific build configurations
210     hereupon apply for the entirety of the build process.
211     '''
212     env['TARGET_OS'] = 'linux'
213     '''
214     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
215     RELEASE packages for OIC. 
216     '''
217     env['CCFLAGS'].append('-g')
218     Export('env')
219 else:
220     '''
221     If target_os is not Yocto, continue with the regular build process
222     '''
223     # Load config of target os
224     env.SConscript(target_os + '/SConscript')
225
226 # Delete the temp files of configuration
227 if env.GetOption('clean'):
228         dir = env.get('SRC_DIR')
229
230         if os.path.exists(dir + '/config.log'):
231                 Execute(Delete(dir + '/config.log'))
232                 Execute(Delete(dir + '/.sconsign.dblite'))
233                 Execute(Delete(dir + '/.sconf_temp'))
234
235 Return('env')