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