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 # Get the device name. This name can be used as network display name wherever possible
  58 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
  59
  60 if ARGUMENTS.get('TEST'):
  61         logging_default = False
  62 else:
  63         release_mode = False
  64         if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
  65                 release_mode = True
  66         logging_default = (release_mode == False)
  67
  68
  69
  70 ######################################################################
  71 # Common build options (release, target os, target arch)
  72 ######################################################################
  73 targets_disallow_multitransport = ['arduino', 'android']
  74
  75 help_vars = Variables()
  76 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
  77 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
  78 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
  79
  80
  81 help_vars.Add(BoolVariable('WITH_RA', 'Build with Remote Access module', False))
  82 help_vars.Add(BoolVariable('WITH_TCP', 'Build with TCP adapter', False))
  83 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
  84 help_vars.Add(EnumVariable('WITH_RD', 'Build including Resource Directory', '0', allowed_values=('0', '1')))
  85
  86 if target_os in targets_disallow_multitransport:
  87         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP']))
  88 else:
  89         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP']))
  90
  91 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
  92 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
  93 help_vars.Add(EnumVariable('DTLS_WITH_X509', 'DTLS with X.509 support', '0', allowed_values=('0', '1')))
  94 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
  95 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
  96 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
  97 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
  98 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
  99 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
 100 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
 101 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
 102 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
 103
 104 AddOption('--prefix',
 105                   dest='prefix',
 106                   type='string',
 107                   nargs=1,
 108                   action='store',
 109                   metavar='DIR',
 110                   help='installation prefix')
 111
 112 ######################################################################
 113 # Platform(build target) specific options: SDK/NDK & toolchain
 114 ######################################################################
 115 targets_support_cc = ['linux', 'arduino', 'tizen']
 116
 117 if target_os in targets_support_cc:
 118         # Set cross compile toolchain
 119         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
 120         help_vars.Add(PathVariable('TC_PATH',
 121                         'Toolchain path (Generally only be required for cross-compiling)',
 122                         os.environ.get('TC_PATH')))
 123
 124 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
 125         env = Environment(variables = help_vars,
 126                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
 127                         )
 128 else:
 129         env = Environment(variables = help_vars, tools = ['default', 'textfile'], TARGET_ARCH = target_arch, TARGET_OS = target_os, PREFIX = GetOption('prefix'))
 130
 131 Help(help_vars.GenerateHelpText(env))
 132
 133 tc_set_msg = '''
 134 ************************************ Warning **********************************
 135 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
 136 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
 137 * cause inexplicable errors.                                                  *
 138 *******************************************************************************
 139 '''
 140 if env.get('VERBOSE') == False:
 141         env['CCCOMSTR'] = "Compiling $TARGET"
 142         env['SHCCCOMSTR'] = "Compiling $TARGET"
 143         env['CXXCOMSTR'] = "Compiling $TARGET"
 144         env['SHCXXCOMSTR'] = "Compiling $TARGET"
 145         env['LINKCOMSTR'] = "Linking $TARGET"
 146         env['SHLINKCOMSTR'] = "Linking $TARGET"
 147         env['ARCOMSTR'] = "Archiving $TARGET"
 148         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
 149
 150 if target_os in targets_support_cc:
 151         prefix = env.get('TC_PREFIX')
 152         tc_path = env.get('TC_PATH')
 153         if prefix:
 154                 env.Replace(CC = prefix + env.get('CC', 'gcc'))
 155                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
 156                 env.Replace(AR = prefix + env.get('AR', 'ar'))
 157                 env.Replace(AS = prefix + env.get('AS', 'as'))
 158                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
 159
 160         if tc_path:
 161                 env.PrependENVPath('PATH', tc_path)
 162                 sys_root = os.path.abspath(tc_path + '/../')
 163                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
 164                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
 165
 166         if prefix or tc_path:
 167                 print tc_set_msg
 168
 169 # Ensure scons be able to change its working directory
 170 env.SConscriptChdir(1)
 171
 172 # Set the source directory and build directory
 173 #   Source directory: 'dir'
 174 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
 175 #
 176 # You can get the directory as following:
 177 #   env.get('SRC_DIR')
 178 #   env.get('BUILD_DIR')
 179
 180 def __set_dir(env, dir):
 181         if not os.path.exists(dir + '/SConstruct'):
 182                 print '''
 183 *************************************** Error *********************************
 184 * The directory(%s) seems isn't a source code directory, no SConstruct file is
 185 * found. *
 186 *******************************************************************************
 187 ''' % dir
 188                 Exit(1)
 189
 190         if env.get('RELEASE'):
 191                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
 192         else:
 193                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
 194         env.VariantDir(build_dir, dir, duplicate=0)
 195
 196         env.Replace(BUILD_DIR = build_dir)
 197         env.Replace(SRC_DIR = dir)
 198
 199 def __src_to_obj(env, src, home = ''):
 200         obj = env.get('BUILD_DIR') + src.replace(home, '')
 201         if env.get('OBJSUFFIX'):
 202                 obj += env.get('OBJSUFFIX')
 203         return env.Object(obj, src)
 204
 205 def __install(ienv, targets, name):
 206         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 207         Alias(name, i_n)
 208         env.AppendUnique(TS = [name])
 209
 210 def __installlib(ienv, targets, name):
 211         user_prefix = env.get('PREFIX')
 212         if user_prefix:
 213                 i_n = ienv.Install(user_prefix + '/lib', targets)
 214         else:
 215                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 216         ienv.Alias("install", i_n)
 217
 218 def __installbin(ienv, targets, name):
 219         user_prefix = env.get('PREFIX')
 220         if user_prefix:
 221                 i_n = ienv.Install(user_prefix + '/bin', targets)
 222         else:
 223                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 224         ienv.Alias("install", i_n)
 225
 226 def __installheader(ienv, targets, dir, name):
 227         user_prefix = env.get('PREFIX')
 228         if user_prefix:
 229                 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
 230         else:
 231                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 232         ienv.Alias("install", i_n)
 233
 234 def __installpcfile(ienv, targets, name):
 235         user_prefix = env.get('PREFIX')
 236         if user_prefix:
 237                 i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
 238         else:
 239                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 240         ienv.Alias("install", i_n)
 241
 242 def __append_target(ienv, name, targets = None):
 243         if targets:
 244                 env.Alias(name, targets)
 245         env.AppendUnique(TS = [name])
 246
 247 def __print_targets(env):
 248         Help('''
 249 ===============================================================================
 250 Targets:\n    ''')
 251         for t in env.get('TS'):
 252                 Help(t + ' ')
 253         Help('''
 254 \nDefault all targets will be built. You can specify the target to build:
 255
 256     $ scons [options] [target]
 257 ===============================================================================
 258 ''')
 259
 260 env.AddMethod(__set_dir, 'SetDir')
 261 env.AddMethod(__print_targets, 'PrintTargets')
 262 env.AddMethod(__src_to_obj, 'SrcToObj')
 263 env.AddMethod(__append_target, 'AppendTarget')
 264 env.AddMethod(__install, 'InstallTarget')
 265 env.AddMethod(__installlib, 'UserInstallTargetLib')
 266 env.AddMethod(__installbin, 'UserInstallTargetBin')
 267 env.AddMethod(__installheader, 'UserInstallTargetHeader')
 268 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
 269 env.SetDir(env.GetLaunchDir())
 270 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
 271
 272 Export('env')
 273
 274 ######################################################################
 275 # Scons to generate the iotivity.pc file from iotivity.pc.in file
 276 ######################################################################
 277 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
 278
 279 user_prefix = env.get('PREFIX')
 280
 281 if user_prefix:
 282         pc_vars = {'\@PREFIX\@': user_prefix, '\@EXEC_PREFIX\@':user_prefix, '\@VERSION\@':'0.9.2'}
 283 else:
 284         pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'), '\@EXEC_PREFIX\@': env.get('BUILD_DIR'), '\@VERSION\@':'0.9.2'}
 285
 286 env.Substfile(pc_file, SUBST_DICT = pc_vars)
 287
 288 ######################################################################
 289 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
 290 ######################################################################
 291 if target_os == "yocto":
 292     '''
 293     This code injects Yocto cross-compilation tools+flags into scons'
 294     build environment in order to invoke the relevant tools while
 295     performing a build.
 296     '''
 297     import os.path
 298     try:
 299         CC = os.environ['CC']
 300         target_prefix = CC.split()[0]
 301         target_prefix = target_prefix[:len(target_prefix)-3]
 302         tools = {"CC" : target_prefix+"gcc",
 303                 "CXX" : target_prefix+"g++",
 304                 "AS" : target_prefix+"as",
 305                 "LD" : target_prefix+"ld",
 306                 "GDB" : target_prefix+"gdb",
 307                 "STRIP" : target_prefix+"strip",
 308                 "RANLIB" : target_prefix+"ranlib",
 309                 "OBJCOPY" : target_prefix+"objcopy",
 310                 "OBJDUMP" : target_prefix+"objdump",
 311                 "AR" : target_prefix+"ar",
 312                 "NM" : target_prefix+"nm",
 313                 "M4" : "m4",
 314                 "STRINGS": target_prefix+"strings"}
 315         PATH = os.environ['PATH'].split(os.pathsep)
 316         for tool in tools:
 317             if tool in os.environ:
 318                 for path in PATH:
 319                     if os.path.isfile(os.path.join(path, tools[tool])):
 320                         env[tool] = os.path.join(path, os.environ[tool])
 321                         break
 322         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
 323     except:
 324         print "ERROR in Yocto cross-toolchain environment"
 325         Exit(1)
 326     '''
 327     Now reset TARGET_OS to linux so that all linux specific build configurations
 328     hereupon apply for the entirety of the build process.
 329     '''
 330     env['TARGET_OS'] = 'linux'
 331     '''
 332     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
 333     RELEASE packages for OIC.
 334     '''
 335     env.AppendUnique(CCFLAGS = ['-g'])
 336     '''
 337     Additional flags to pass to the Yocto toolchain.
 338     '''
 339     if env.get('RELEASE'):
 340         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
 341     if env.get('LOGGING'):
 342         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
 343     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
 344     env.AppendUnique(CFLAGS = ['-std=gnu99'])
 345     env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
 346     env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
 347     env.AppendUnique(LIBS = ['uuid'])
 348     Export('env')
 349 else:
 350     '''
 351     If target_os is not Yocto, continue with the regular build process
 352     '''
 353     # Load config of target os
 354     env.SConscript(target_os + '/SConscript')
 355
 356 # Delete the temp files of configuration
 357 if env.GetOption('clean'):
 358         dir = env.get('SRC_DIR')
 359
 360         if os.path.exists(dir + '/config.log'):
 361                 Execute(Delete(dir + '/config.log'))
 362         if os.path.exists(dir + '/.sconsign.dblite'):
 363                 Execute(Delete(dir + '/.sconsign.dblite'))
 364         if os.path.exists(dir + '/.sconf_temp'):
 365                 Execute(Delete(dir + '/.sconf_temp'))
 366
 367 ######################################################################
 368 # Check for PThreads support
 369 ######################################################################
 370 import iotivityconfig
 371 from iotivityconfig import *
 372
 373 conf = Configure(env,
 374         custom_tests =
 375         {
 376             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
 377         } )
 378
 379 # Identify whether we have pthreads support, which is necessary for
 380 # threading and mutexes.  This will set the environment variable
 381 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
 382 conf.CheckPThreadsSupport()
 383
 384 env = conf.Finish()
 385 ######################################################################
 386
 387 env.SConscript('external_libs.scons')
 388 Return('env')