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