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 + env.get('CC', 'gcc'))
  91                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
  92                 env.Replace(AR = prefix + env.get('AR', 'ar'))
  93                 env.Replace(AS = prefix + env.get('AS', 'as'))
  94                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
  95
  96         if tc_path:
  97                 env.PrependENVPath('PATH', tc_path)
  98                 sys_root = os.path.abspath(os.path.join(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(os.path.join(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         build_dir = os.path.join(dir, 'out', target_os, target_arch)
 127         if env.get('RELEASE'):
 128                 build_dir = os.path.join(build_dir, 'release')
 129         else:
 130                 build_dir = os.path.join(build_dir, '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, name, targets = None):
 148         if targets:
 149                 env.Alias(name, targets)
 150         env.AppendUnique(TS = [name])
 151
 152 def __print_targets(env):
 153         Help('''
 154 ===============================================================================
 155 Targets:\n    ''')
 156         for t in env.get('TS'):
 157                 Help(t + ' ')
 158         Help('''
 159 \nDefault all targets will be built. You can specify the target to build:
 160
 161     $ scons [options] [target]
 162 ===============================================================================
 163 ''')
 164
 165 env.AddMethod(__set_dir, 'SetDir')
 166 env.AddMethod(__print_targets, 'PrintTargets')
 167 env.AddMethod(__src_to_obj, 'SrcToObj')
 168 env.AddMethod(__append_target, 'AppendTarget')
 169 env.AddMethod(__install, 'InstallTarget')
 170 env.SetDir(env.GetLaunchDir())
 171
 172 Export('env')
 173
 174 # Delete the temporary build and configuration files
 175 if env.GetOption('clean'):
 176     # Retrieve the configure log file and test directory nodes from the
 177     # appropriate construction variables.
 178     config_log = File(env['CONFIGURELOG'])
 179     config_dir = Dir(env['CONFIGUREDIR'])
 180
 181     # The '.sconsign.dblite' file.
 182     sconsign_dblite = os.path.join(env.get('SRC_DIR'),
 183                                    '.sconsign.dblite')
 184
 185     if os.path.exists(str(config_log)):
 186         Execute(Delete(config_log))
 187         Execute(Delete(config_dir))
 188         Execute(Delete(sconsign_dblite))
 189
 190 ######################################################################
 191 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
 192 ######################################################################
 193 if target_os == "yocto":
 194     '''
 195     This code injects Yocto cross-compilation tools+flags into scons'
 196     build environment in order to invoke the relevant tools while
 197     performing a build.
 198     '''
 199     import os.path
 200     try:
 201         CC = os.environ['CC']
 202         target_prefix = CC.split()[0]
 203         target_prefix = target_prefix[:len(target_prefix)-3]
 204         tools = {"CC" : target_prefix+"gcc",
 205                 "CXX" : target_prefix+"g++",
 206                 "AS" : target_prefix+"as",
 207                 "LD" : target_prefix+"ld",
 208                 "GDB" : target_prefix+"gdb",
 209                 "STRIP" : target_prefix+"strip",
 210                 "RANLIB" : target_prefix+"ranlib",
 211                 "OBJCOPY" : target_prefix+"objcopy",
 212                 "OBJDUMP" : target_prefix+"objdump",
 213                 "AR" : target_prefix+"ar",
 214                 "NM" : target_prefix+"nm",
 215                 "M4" : "m4",
 216                 "STRINGS": target_prefix+"strings"}
 217         PATH = os.environ['PATH'].split(os.pathsep)
 218         for tool in tools:
 219             if tool in os.environ:
 220                 for path in PATH:
 221                     if os.path.isfile(os.path.join(path, tools[tool])):
 222                         env[tool] = os.path.join(path, os.environ[tool])
 223                         break
 224     except:
 225         print "ERROR in Yocto cross-toolchain environment"
 226         Exit(1)
 227     '''
 228     Now reset TARGET_OS to linux so that all linux specific build configurations
 229     hereupon apply for the entirety of the build process.
 230     '''
 231     env['TARGET_OS'] = 'linux'
 232     '''
 233     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
 234     RELEASE packages for OIC.
 235     '''
 236     env['CCFLAGS'].append('-g')
 237     Export('env')
 238 else:
 239     '''
 240     If target_os is not Yocto, continue with the regular build process
 241     '''
 242     # Load config of target os
 243     if target_os in ['linux', 'tizen']:
 244             env.SConscript('linux/SConscript')
 245     else:
 246             env.SConscript(target_os + '/SConscript')
 247
 248 # -------------------------------------------------------------------
 249 # Configure the build as needed, e.g. detecting and setting
 250 # appropriate build flags, etc.
 251 #
 252 # This is done after the platform-specific configuration is loaded to
 253 # make sure we give the automated build configuration below an
 254 # opportunity to detect platform-specific anomalies.
 255 # -------------------------------------------------------------------
 256 if not env.GetOption('clean') and not env.GetOption('help'):
 257     Import('targets_csdk_only')
 258     import iotivityconfig
 259     from iotivityconfig import *
 260
 261     conf = env.Configure(
 262         custom_tests = {
 263                 'CheckC99Flags' : iotivityconfig.check_c99_flags,
 264                 'CheckCXX11Flags' : iotivityconfig.check_cxx11_flags
 265         } )
 266
 267     # IoTivity requires support for C99 for the C SDK.
 268     if not conf.CheckC99Flags():
 269         print('C99 support is required!')
 270         Exit(1)
 271
 272     # IoTivity requires support for C++11 for the C++ SDK.
 273     #
 274     # However, some platforms, such as Arduino, only support the C
 275     # SDK.  Don't bother running the C++11 check in those cases.
 276     if target_os not in targets_csdk_only and not conf.CheckCXX11Flags():
 277         print('C++11 support is required!')
 278         Exit(1)
 279
 280     env = conf.Finish()
 281 # -------------------------------------------------------------------
 282
 283 env.SConscript('external_libs.scons')
 284
 285 # Check if C/C++ compiler is installed
 286 cc = env.get('CC', '')
 287 cxx = env.get('CXX', '')
 288
 289 if not cc:
 290         print '''
 291 *************************************** Error *********************************
 292 *                                                                             *
 293 * Didn't find C compiler, please install C compiler (e.g. gcc >= 4.6).        *
 294 *                                                                             *
 295 *******************************************************************************
 296 '''
 297         Exit(1)
 298
 299 if not cxx:
 300         print '''
 301 *************************************** Error *********************************
 302 *                                                                             *
 303 * Didn't find C++ compiler, please install C++ compiler (e.g. g++ >= 4.6)     *
 304 *                                                                             *
 305 *******************************************************************************
 306 '''
 307         Exit(1)
 308
 309 Return('env')