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