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