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