build_common/SConscript

   1 # -*- mode: python; python-indent-offset: 4; indent-tabs-mode: nil -*-
   2 ##
   3 # This script includes generic build options:
   4 #    release/debug, target os, target arch, cross toolchain, build environment etc
   5 ##
   6 import os
   7 import platform
   8
   9 project_version = '1.2.1'
  10
  11 # Map of host os and allowed target os (host: allowed target os)
  12 host_target_map = {
  13                 'linux': ['linux', 'android', 'arduino', 'yocto', 'tizen', 'tizenrt'],
  14                 'windows': ['windows', 'android', 'arduino'],
  15                 'darwin': ['darwin', 'ios', 'android', 'arduino'],
  16                 'msys_nt' :['msys_nt'],
  17                 }
  18
  19 # Map of os and allowed archs (os: allowed archs)
  20 os_arch_map = {
  21                 'linux': ['x86', 'x86_64', 'arm', 'arm-v7a', 'armeabi-v7a', 'arm64'],
  22                 'tizen': ['x86', 'x86_64', 'arm', 'arm-v7a', 'armeabi-v7a', 'arm64'],
  23                 'android': ['x86', 'x86_64', 'armeabi', 'armeabi-v7a', 'armeabi-v7a-hard', 'arm64-v8a'],
  24                 'windows': ['x86', 'amd64', 'arm'],
  25                 'msys_nt':['x86', 'x86_64'],
  26                 'darwin': ['i386', 'x86_64'],
  27                 'ios': ['i386', 'x86_64', 'armv7', 'armv7s', 'arm64'],
  28                 'arduino': ['avr', 'arm'],
  29                 'yocto': ['i586', 'i686', 'x86_64', 'arm', 'aarch64', 'powerpc', 'powerpc64', 'mips', 'mipsel'],
  30                 'tizenrt': ['armv7-r', 'armv7-m'],
  31                 }
  32
  33 host = platform.system().lower()
  34
  35 # the host string contains version of windows. 6.3, 6.4, 10.0 which is 8.0, 8.1, and 10 respectively.
  36 # Let's canonicalize the msys_nt-XX.X system name by stripping version off.
  37 if 'msys_nt' in host:
  38         host = 'msys_nt'
  39
  40 if not host_target_map.has_key(host):
  41         print "\nError: Current system (%s) isn't supported\n" % host
  42         Exit(1)
  43
  44 ######################################################################
  45 # Get build options (the optins from command line)
  46 ######################################################################
  47 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
  48
  49 if target_os not in host_target_map[host]:
  50         print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
  51         Exit(1)
  52
  53 if target_os == 'android':
  54         default_arch = 'x86'
  55 else:
  56         default_arch = platform.machine()
  57
  58 if default_arch not in os_arch_map[target_os]:
  59         default_arch = os_arch_map[target_os][0].lower()
  60
  61 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
  62
  63 # True if binary needs to be installed on board. (Might need root permissions)
  64 # set to 'no', 'false' or 0 for only compilation
  65 require_upload = ARGUMENTS.get('UPLOAD', False)
  66
  67 # Get the device name. This name can be used as network display name wherever possible
  68 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
  69
  70 default_with_upstream_libcoap = 0
  71
  72 if ARGUMENTS.get('TEST'):
  73         logging_default = False
  74 else:
  75         release_mode = False
  76         if ARGUMENTS.get('RELEASE', True) in ['y', 'yes', 'true', 't', '1', 'on', 'all', True]:
  77                 release_mode = True
  78         logging_default = (release_mode == False)
  79
  80 # targets that do not support the DTLS build (SECURED=1 build option)
  81 targets_without_dtls_support = ['arduino'];
  82 if ARGUMENTS.get('SECURED') == '1' and target_os in targets_without_dtls_support:
  83         print "\nError: DTLS not supported on target os: %s MUST build with SECURED=0\n" % (target_os)
  84         Exit(1)
  85
  86 ######################################################################
  87 # Common build options (release, target os, target arch)
  88 ######################################################################
  89 targets_disallow_multitransport = ['arduino']
  90
  91 help_vars = Variables()
  92 help_vars.Add(BoolVariable('VERBOSE', 'Show compilation', False))
  93 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
  94 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
  95
  96
  97 help_vars.Add(BoolVariable('WITH_RA', 'Build with Remote Access module', False))
  98 help_vars.Add(BoolVariable('WITH_TCP', 'Build with TCP adapter', False))
  99 help_vars.Add(BoolVariable('WITH_PROXY', 'Build with CoAP-HTTP Proxy', False))
 100 help_vars.Add(ListVariable('WITH_MQ', 'Build with MQ publisher/broker', 'OFF', ['OFF', 'SUB', 'PUB', 'BROKER']))
 101 help_vars.Add(BoolVariable('WITH_CLOUD', 'Build including AccountManager class and Cloud Client sample', False))
 102 help_vars.Add(ListVariable('RD_MODE', 'Resource Directory build mode', 'CLIENT', ['CLIENT', 'SERVER']))
 103
 104 help_vars.Add(BoolVariable('SIMULATOR', 'Build with simulator module', False))
 105
 106 help_vars.Add(BoolVariable('WITH_RA_IBB', 'Build with Remote Access module(workssys)', False))
 107 help_vars.Add(BoolVariable('WITH_ASAN', 'Build with Address Sanitizer support', False))
 108
 109
 110 if target_os in targets_disallow_multitransport:
 111         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'IP', ['BT', 'BLE', 'IP', 'NFC']))
 112 else:
 113         help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP', 'NFC']))
 114
 115 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
 116 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
 117 help_vars.Add(EnumVariable('WITH_MBEDTLS_STATIC_LIB', 'Build mbedTLS library as static library', '0', allowed_values=('0', '1')))
 118 help_vars.Add(EnumVariable('MULTIPLE_OWNER', 'Enable multiple owner', '0', allowed_values=('0', '1')))
 119 help_vars.Add(EnumVariable('EXC_PROV_SUPPORT', 'Except OCPMAPI library(libocpmapi.so)', '0', allowed_values=('0', '1')))
 120 help_vars.Add(EnumVariable('TEST', 'Run unit tests', '0', allowed_values=('0', '1')))
 121 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', logging_default))
 122 help_vars.Add(EnumVariable('LOG_LEVEL', 'Enable stack logging level', 'DEBUG', allowed_values=('DEBUG', 'INFO', 'ERROR', 'WARNING', 'FATAL')))
 123 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
 124 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
 125 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
 126 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device (For Arduino)', device_name, None, None),)
 127 help_vars.Add(PathVariable('ANDROID_NDK', 'Android NDK path', None, PathVariable.PathAccept))
 128 help_vars.Add(PathVariable('ANDROID_HOME', 'Android SDK path', None, PathVariable.PathAccept))
 129 help_vars.Add(PathVariable('ANDROID_GRADLE', 'Gradle binary file', None, PathVariable.PathIsFile))
 130 help_vars.Add(EnumVariable('WITH_UPSTREAM_LIBCOAP', 'Use latest stable version of LibCoAP downloaded from github', default_with_upstream_libcoap, allowed_values=('0','1')))
 131 help_vars.Add(EnumVariable('BLE_CUSTOM_ADV', 'Build with CUSTOM Advertisement', 'False', allowed_values=('True', 'False')))
 132 help_vars.Add(EnumVariable('BLE_DIVISION', 'BLE Build with division code', 'OFF', allowed_values=('OFF', 'MCD', 'VD')))
 133 help_vars.Add(EnumVariable('BLE_TIZEN_30', 'Build with tizen 3.0 BLE api', 'False', allowed_values=('True', 'False')))
 134 help_vars.Add(PathVariable('TIZENRT_OS_DIR', 'Absolute Path to TizenRT OS directory', None, PathVariable.PathAccept))
 135 help_vars.Add(EnumVariable('PLATFORM_TLS', 'Use platform tls instead of local mbedtls', '0', allowed_values=('0', '1')))
 136 help_vars.Add(EnumVariable('OIC_SUPPORT_TIZEN_TRACE', 'Tizen Trace(T-trace) api availability', 'False', allowed_values=('True', 'False')))
 137 AddOption('--prefix',
 138                   dest='prefix',
 139                   type='string',
 140                   nargs=1,
 141                   action='store',
 142                   metavar='DIR',
 143                   help='installation prefix')
 144
 145 ######################################################################
 146 # Platform(build target) specific options: SDK/NDK & toolchain
 147 ######################################################################
 148 targets_support_cc = ['linux', 'arduino', 'tizen', 'tizenrt']
 149
 150 if target_os in targets_support_cc:
 151         # Set cross compile toolchain
 152         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
 153         help_vars.Add(PathVariable('TC_PATH',
 154                         'Toolchain path (Generally only be required for cross-compiling)',
 155                         os.environ.get('TC_PATH')))
 156
 157 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
 158         env = Environment(variables = help_vars,
 159                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as', 'textfile']
 160                         )
 161 else:
 162         env = Environment(variables = help_vars, tools = ['default', 'textfile'],
 163                         TARGET_ARCH = target_arch, TARGET_OS = target_os,
 164                         PREFIX = GetOption('prefix'),
 165                         LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR') #for 64bit build
 166                         )
 167 Help(help_vars.GenerateHelpText(env))
 168
 169 tc_set_msg = '''
 170 ************************************ Warning **********************************
 171 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
 172 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
 173 * cause inexplicable errors.                                                  *
 174 *******************************************************************************
 175 '''
 176 if env.get('VERBOSE') == False:
 177         env['CCCOMSTR'] = "Compiling $TARGET"
 178         env['SHCCCOMSTR'] = "Compiling $TARGET"
 179         env['CXXCOMSTR'] = "Compiling $TARGET"
 180         env['SHCXXCOMSTR'] = "Compiling $TARGET"
 181         env['LINKCOMSTR'] = "Linking $TARGET"
 182         env['SHLINKCOMSTR'] = "Linking $TARGET"
 183         env['ARCOMSTR'] = "Archiving $TARGET"
 184         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
 185
 186 if target_os in targets_support_cc:
 187         prefix = env.get('TC_PREFIX')
 188         tc_path = env.get('TC_PATH')
 189         if prefix:
 190                 env.Replace(CC = prefix + env.get('CC', 'gcc'))
 191                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
 192                 env.Replace(AR = prefix + env.get('AR', 'ar'))
 193                 env.Replace(AS = prefix + env.get('AS', 'as'))
 194                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
 195
 196         if tc_path:
 197                 env.PrependENVPath('PATH', tc_path)
 198                 sys_root = os.path.abspath(tc_path + '/../')
 199                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
 200                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
 201
 202         if target_os == 'tizenrt':
 203                 env.PrependENVPath('PATH', os.environ['PATH'])
 204
 205         if prefix or tc_path:
 206                 print tc_set_msg
 207
 208 # If cross-compiling, honor environment settings for toolchain to avoid picking up native tools
 209 if os.environ.get('PKG_CONFIG') != None:
 210         env["ENV"]["PKG_CONFIG"] = os.environ.get("PKG_CONFIG")
 211 if os.environ.get('PKG_CONFIG_PATH') != None:
 212         env["ENV"]["PKG_CONFIG_PATH"] = os.environ.get("PKG_CONFIG_PATH")
 213 if os.environ.get('PKG_CONFIG_SYSROOT_DIR') != None:
 214         env["ENV"]["PKG_CONFIG_SYSROOT_DIR"] = os.environ.get("PKG_CONFIG_SYSROOT_DIR")
 215
 216 # Ensure scons be able to change its working directory
 217 env.SConscriptChdir(1)
 218
 219 # Set the source directory and build directory
 220 #   Source directory: 'dir'
 221 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
 222 #
 223 # You can get the directory as following:
 224 #   env.get('SRC_DIR')
 225 #   env.get('BUILD_DIR')
 226
 227 def __set_dir(env, dir):
 228         if not os.path.exists(dir + '/SConstruct'):
 229                 print '''
 230 *************************************** Error *********************************
 231 * The directory(%s) seems isn't a source code directory, no SConstruct file is
 232 * found. *
 233 *******************************************************************************
 234 ''' % dir
 235                 Exit(1)
 236
 237         if env.get('RELEASE'):
 238                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
 239         else:
 240                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
 241         env.VariantDir(build_dir, dir, duplicate=0)
 242
 243         env.Replace(BUILD_DIR = build_dir)
 244         env.Replace(SRC_DIR = dir)
 245
 246 def __src_to_obj(env, src, home = ''):
 247         obj = env.get('BUILD_DIR') + src.replace(home, '')
 248         if env.get('OBJSUFFIX'):
 249                 obj += env.get('OBJSUFFIX')
 250         return env.Object(obj, src)
 251
 252 def __install(ienv, targets, name):
 253         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 254         Alias(name, i_n)
 255         env.AppendUnique(TS = [name])
 256
 257 def __installlib(ienv, targets, name):
 258         user_prefix = env.get('PREFIX')
 259         if user_prefix:
 260                 user_lib = env.get('LIB_INSTALL_DIR')
 261                 if user_lib:
 262                         i_n = ienv.Install(user_lib, targets)
 263                 else:
 264                         i_n = ienv.Install(user_prefix + '/lib', targets)
 265                 ienv.Alias("install", i_n)
 266         else:
 267                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 268         ienv.Alias("install", i_n)
 269
 270 def __installbin(ienv, targets, name):
 271         user_prefix = env.get('PREFIX')
 272         if user_prefix:
 273                 i_n = ienv.Install(user_prefix + '/bin', targets)
 274                 ienv.Alias("install", i_n)
 275
 276 def __installheader(ienv, targets, dir, name):
 277         user_prefix = env.get('PREFIX')
 278         if user_prefix:
 279                 i_n = ienv.Install(user_prefix + '/include/' + dir ,targets)
 280         else:
 281                 i_n = ienv.Install(os.path.join(env.get('BUILD_DIR'), 'include', dir), targets)
 282         ienv.Alias("install", i_n)
 283
 284 def __installpcfile(ienv, targets, name):
 285         user_prefix = env.get('PREFIX')
 286         if user_prefix:
 287                 user_lib = env.get('LIB_INSTALL_DIR')
 288                 if user_lib:
 289                         i_n = ienv.Install(user_lib + '/pkgconfig', targets)
 290                 else:
 291                         i_n = ienv.Install(user_prefix + '/lib/pkgconfig', targets)
 292         else:
 293                 i_n = ienv.Install(env.get('BUILD_DIR') + 'lib/pkgconfig', targets)
 294         ienv.Alias("install", i_n)
 295
 296 def __append_target(ienv, name, targets = None):
 297         if targets:
 298                 env.Alias(name, targets)
 299         env.AppendUnique(TS = [name])
 300
 301 def __print_targets(env):
 302         Help('''
 303 ===============================================================================
 304 Targets:\n    ''')
 305         for t in env.get('TS'):
 306                 Help(t + ' ')
 307         Help('''
 308 \nDefault all targets will be built. You can specify the target to build:
 309
 310     $ scons [options] [target]
 311 ===============================================================================
 312 ''')
 313
 314 env.AddMethod(__set_dir, 'SetDir')
 315 env.AddMethod(__print_targets, 'PrintTargets')
 316 env.AddMethod(__src_to_obj, 'SrcToObj')
 317 env.AddMethod(__append_target, 'AppendTarget')
 318 env.AddMethod(__install, 'InstallTarget')
 319 env.AddMethod(__installlib, 'UserInstallTargetLib')
 320 env.AddMethod(__installbin, 'UserInstallTargetBin')
 321 env.AddMethod(__installheader, 'UserInstallTargetHeader')
 322 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
 323 env.SetDir(env.GetLaunchDir())
 324 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
 325
 326 Export('env')
 327
 328 ######################################################################
 329 # Scons to generate the iotivity.pc file from iotivity.pc.in file
 330 ######################################################################
 331 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
 332
 333 user_prefix = env.get('PREFIX')
 334 user_lib = env.get('LIB_INSTALL_DIR')
 335
 336 if not user_prefix:
 337     user_prefix = env.get('BUILD_DIR').encode('string_escape')
 338
 339 if not user_lib:
 340     user_lib = '$${prefix}/lib'
 341
 342 defines = []
 343 if env.get('LOGGING'):
 344     defines.append('-DTB_LOG=1')
 345
 346 if env.get('ROUTING') == 'GW':
 347     defines.append('-DROUTING_GATEWAY=1')
 348 elif env.get('ROUTING') == 'EP':
 349     defines.append('-DROUTING_EP=1')
 350
 351 if env.get('WITH_TCP'):
 352     defines.append('-DTCP_ADAPTER=1')
 353     if env.get('SECURED') == '1':
 354         defines.append('-D__WITH_TLS__=1')
 355
 356 libs = []
 357 if env.get('SECURED') == '1':
 358     defines.append('-D__WITH_DTLS__=1')
 359     if env.get('EXC_PROV_SUPPORT') == '0':
 360         libs.append('-locpmapi')        # CAPI
 361         libs.append('-locprovision')    # C++API
 362
 363 pc_vars = {
 364     '\@VERSION\@': project_version,
 365     '\@PREFIX\@': user_prefix,
 366     '\@EXEC_PREFIX\@': user_prefix,
 367     '\@LIB_INSTALL_DIR\@': user_lib,
 368     '\@DEFINES\@': " ".join(defines),
 369     '\@LIBS\@': " ".join(libs)
 370 }
 371
 372 env.Substfile(pc_file, SUBST_DICT = pc_vars)
 373
 374 ######################################################################
 375 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
 376 ######################################################################
 377 if target_os == "yocto":
 378     '''
 379     This code injects Yocto cross-compilation tools+flags into scons'
 380     build environment in order to invoke the relevant tools while
 381     performing a build.
 382     '''
 383     import os.path
 384     try:
 385         CC = os.environ['CC']
 386         target_prefix = CC.split()[0]
 387         target_prefix = target_prefix[:len(target_prefix)-3]
 388         tools = {"CC" : target_prefix+"gcc",
 389                 "CXX" : target_prefix+"g++",
 390                 "AS" : target_prefix+"as",
 391                 "LD" : target_prefix+"ld",
 392                 "GDB" : target_prefix+"gdb",
 393                 "STRIP" : target_prefix+"strip",
 394                 "RANLIB" : target_prefix+"ranlib",
 395                 "OBJCOPY" : target_prefix+"objcopy",
 396                 "OBJDUMP" : target_prefix+"objdump",
 397                 "AR" : target_prefix+"ar",
 398                 "NM" : target_prefix+"nm",
 399                 "M4" : "m4",
 400                 "STRINGS": target_prefix+"strings"}
 401         PATH = os.environ['PATH'].split(os.pathsep)
 402         for tool in tools:
 403             if tool in os.environ:
 404                 for path in PATH:
 405                     if os.path.isfile(os.path.join(path, tools[tool])):
 406                         env[tool] = os.path.join(path, os.environ[tool])
 407                         break
 408         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
 409         if os.environ['LDFLAGS'] != None:
 410             env.AppendUnique(LINKFLAGS = Split(os.environ['LDFLAGS']))
 411     except:
 412         print "ERROR in Yocto cross-toolchain environment"
 413         Exit(1)
 414     '''
 415     Now reset TARGET_OS to linux so that all linux specific build configurations
 416     hereupon apply for the entirety of the build process.
 417     '''
 418     env['TARGET_OS'] = 'linux'
 419     '''
 420     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
 421     RELEASE packages for OIC.
 422     '''
 423     env.AppendUnique(CCFLAGS = ['-g'])
 424     '''
 425     Additional flags to pass to the Yocto toolchain.
 426     '''
 427     if env.get('RELEASE'):
 428         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
 429     if env.get('LOGGING'):
 430         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
 431     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
 432     env.AppendUnique(CFLAGS = ['-std=gnu99'])
 433     env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
 434     env.AppendUnique(LIBS = ['dl', 'pthread', 'uuid'])
 435     Export('env')
 436 else:
 437     '''
 438     If target_os is not Yocto, continue with the regular build process
 439     '''
 440     # Load config of target os
 441     env.SConscript(target_os + '/SConscript')
 442
 443 # Delete the temp files of configuration
 444 if env.GetOption('clean'):
 445         dir = env.get('SRC_DIR')
 446
 447         if os.path.exists(dir + '/config.log'):
 448                 Execute(Delete(dir + '/config.log'))
 449         if os.path.exists(dir + '/.sconsign.dblite'):
 450                 Execute(Delete(dir + '/.sconsign.dblite'))
 451         if os.path.exists(dir + '/.sconf_temp'):
 452                 Execute(Delete(dir + '/.sconf_temp'))
 453
 454 ######################################################################
 455 # Check for PThreads support
 456 ######################################################################
 457 import iotivityconfig
 458 from iotivityconfig import *
 459
 460 conf = Configure(env,
 461         custom_tests =
 462         {
 463             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
 464         } )
 465
 466 # Identify whether we have pthreads support, which is necessary for
 467 # threading and mutexes.  This will set the environment variable
 468 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
 469 conf.CheckPThreadsSupport()
 470
 471 env = conf.Finish()
 472 ######################################################################
 473
 474 env.SConscript('external_libs.scons')
 475 Return('env')