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