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