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'],
 130                         TARGET_ARCH = target_arch, TARGET_OS = target_os,
 131                         PREFIX = GetOption('prefix'),
 132                         LIB_INSTALL_DIR = ARGUMENTS.get('LIB_INSTALL_DIR', '/usr/lib')
 133                         )
 134 Help(help_vars.GenerateHelpText(env))
 135
 136 tc_set_msg = '''
 137 ************************************ Warning **********************************
 138 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
 139 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
 140 * cause inexplicable errors.                                                  *
 141 *******************************************************************************
 142 '''
 143 if env.get('VERBOSE') == False:
 144         env['CCCOMSTR'] = "Compiling $TARGET"
 145         env['SHCCCOMSTR'] = "Compiling $TARGET"
 146         env['CXXCOMSTR'] = "Compiling $TARGET"
 147         env['SHCXXCOMSTR'] = "Compiling $TARGET"
 148         env['LINKCOMSTR'] = "Linking $TARGET"
 149         env['SHLINKCOMSTR'] = "Linking $TARGET"
 150         env['ARCOMSTR'] = "Archiving $TARGET"
 151         env['RANLIBCOMSTR'] = "Indexing Archive $TARGET"
 152
 153 if target_os in targets_support_cc:
 154         prefix = env.get('TC_PREFIX')
 155         tc_path = env.get('TC_PATH')
 156         if prefix:
 157                 env.Replace(CC = prefix + env.get('CC', 'gcc'))
 158                 env.Replace(CXX = prefix + env.get('CXX', 'g++'))
 159                 env.Replace(AR = prefix + env.get('AR', 'ar'))
 160                 env.Replace(AS = prefix + env.get('AS', 'as'))
 161                 env.Replace(RANLIB = prefix + env.get('RANLIB', 'ranlib'))
 162
 163         if tc_path:
 164                 env.PrependENVPath('PATH', tc_path)
 165                 sys_root = os.path.abspath(tc_path + '/../')
 166                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
 167                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
 168
 169         if prefix or tc_path:
 170                 print tc_set_msg
 171
 172 # Ensure scons be able to change its working directory
 173 env.SConscriptChdir(1)
 174
 175 # Set the source directory and build directory
 176 #   Source directory: 'dir'
 177 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
 178 #
 179 # You can get the directory as following:
 180 #   env.get('SRC_DIR')
 181 #   env.get('BUILD_DIR')
 182
 183 def __set_dir(env, dir):
 184         if not os.path.exists(dir + '/SConstruct'):
 185                 print '''
 186 *************************************** Error *********************************
 187 * The directory(%s) seems isn't a source code directory, no SConstruct file is
 188 * found. *
 189 *******************************************************************************
 190 ''' % dir
 191                 Exit(1)
 192
 193         if env.get('RELEASE'):
 194                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/release/'
 195         else:
 196                 build_dir = dir + '/out/' + target_os + '/' + target_arch + '/debug/'
 197         env.VariantDir(build_dir, dir, duplicate=0)
 198
 199         env.Replace(BUILD_DIR = build_dir)
 200         env.Replace(SRC_DIR = dir)
 201
 202 def __src_to_obj(env, src, home = ''):
 203         obj = env.get('BUILD_DIR') + src.replace(home, '')
 204         if env.get('OBJSUFFIX'):
 205                 obj += env.get('OBJSUFFIX')
 206         return env.Object(obj, src)
 207
 208 def __install(ienv, targets, name):
 209         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 210         Alias(name, i_n)
 211         env.AppendUnique(TS = [name])
 212
 213 def __installlib(ienv, targets, name):
 214         user_prefix = env.get('PREFIX')
 215         if user_prefix:
 216                 i_n = ienv.Install(env.get('LIB_INSTALL_DIR'), targets)
 217         else:
 218                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 219         ienv.Alias("install", i_n)
 220
 221 def __installbin(ienv, targets, name):
 222         user_prefix = env.get('PREFIX')
 223         if user_prefix:
 224                 i_n = ienv.Install(user_prefix + '/bin', targets)
 225         else:
 226                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 227         ienv.Alias("install", i_n)
 228
 229 def __installheader(ienv, targets, dir, name):
 230         user_prefix = env.get('PREFIX')
 231         if user_prefix:
 232                 i_n = ienv.Install(user_prefix + '/include/' + dir, targets)
 233         else:
 234                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 235         ienv.Alias("install", i_n)
 236
 237 def __installpcfile(ienv, targets, name):
 238         user_prefix = env.get('PREFIX')
 239         if user_prefix:
 240                 i_n = ienv.Install(env.get('LIB_INSTALL_DIR') + '/pkgconfig', targets)
 241         else:
 242                 i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 243         ienv.Alias("install", i_n)
 244
 245 def __append_target(ienv, name, targets = None):
 246         if targets:
 247                 env.Alias(name, targets)
 248         env.AppendUnique(TS = [name])
 249
 250 def __print_targets(env):
 251         Help('''
 252 ===============================================================================
 253 Targets:\n    ''')
 254         for t in env.get('TS'):
 255                 Help(t + ' ')
 256         Help('''
 257 \nDefault all targets will be built. You can specify the target to build:
 258
 259     $ scons [options] [target]
 260 ===============================================================================
 261 ''')
 262
 263 env.AddMethod(__set_dir, 'SetDir')
 264 env.AddMethod(__print_targets, 'PrintTargets')
 265 env.AddMethod(__src_to_obj, 'SrcToObj')
 266 env.AddMethod(__append_target, 'AppendTarget')
 267 env.AddMethod(__install, 'InstallTarget')
 268 env.AddMethod(__installlib, 'UserInstallTargetLib')
 269 env.AddMethod(__installbin, 'UserInstallTargetBin')
 270 env.AddMethod(__installheader, 'UserInstallTargetHeader')
 271 env.AddMethod(__installpcfile, 'UserInstallTargetPCFile')
 272 env.SetDir(env.GetLaunchDir())
 273 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
 274
 275 Export('env')
 276
 277 ######################################################################
 278 # Scons to generate the iotivity.pc file from iotivity.pc.in file
 279 ######################################################################
 280 pc_file = env.get('SRC_DIR') + '/iotivity.pc.in'
 281
 282 if env.get('ROUTING') == 'GW':
 283         routing_define = 'ROUTING_GATEWAY'
 284 elif env.get('ROUTING') == 'EP':
 285         routing_define = 'ROUTING_EP'
 286
 287 user_prefix = env.get('PREFIX')
 288
 289 if user_prefix:
 290         pc_vars = {'\@PREFIX\@': user_prefix,
 291                                 '\@LIB_INSTALL_DIR\@': env.get('LIB_INSTALL_DIR'),
 292                                 '\@VERSION\@': '1.0.0', '\@ROUTING_DEFINE\@': routing_define
 293                                 }
 294 else:
 295         pc_vars = {'\@PREFIX\@': env.get('BUILD_DIR'), '\@VERSION\@': '1.0.0',
 296                                 '\@ROUTING_DEFINE\@': routing_define
 297                                 }
 298
 299 env.Substfile(pc_file, SUBST_DICT = pc_vars)
 300
 301 ######################################################################
 302 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
 303 ######################################################################
 304 if target_os == "yocto":
 305     '''
 306     This code injects Yocto cross-compilation tools+flags into scons'
 307     build environment in order to invoke the relevant tools while
 308     performing a build.
 309     '''
 310     import os.path
 311     try:
 312         CC = os.environ['CC']
 313         target_prefix = CC.split()[0]
 314         target_prefix = target_prefix[:len(target_prefix)-3]
 315         tools = {"CC" : target_prefix+"gcc",
 316                 "CXX" : target_prefix+"g++",
 317                 "AS" : target_prefix+"as",
 318                 "LD" : target_prefix+"ld",
 319                 "GDB" : target_prefix+"gdb",
 320                 "STRIP" : target_prefix+"strip",
 321                 "RANLIB" : target_prefix+"ranlib",
 322                 "OBJCOPY" : target_prefix+"objcopy",
 323                 "OBJDUMP" : target_prefix+"objdump",
 324                 "AR" : target_prefix+"ar",
 325                 "NM" : target_prefix+"nm",
 326                 "M4" : "m4",
 327                 "STRINGS": target_prefix+"strings"}
 328         PATH = os.environ['PATH'].split(os.pathsep)
 329         for tool in tools:
 330             if tool in os.environ:
 331                 for path in PATH:
 332                     if os.path.isfile(os.path.join(path, tools[tool])):
 333                         env[tool] = os.path.join(path, os.environ[tool])
 334                         break
 335         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
 336     except:
 337         print "ERROR in Yocto cross-toolchain environment"
 338         Exit(1)
 339     '''
 340     Now reset TARGET_OS to linux so that all linux specific build configurations
 341     hereupon apply for the entirety of the build process.
 342     '''
 343     env['TARGET_OS'] = 'linux'
 344     '''
 345     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
 346     RELEASE packages for OIC.
 347     '''
 348     env.AppendUnique(CCFLAGS = ['-g'])
 349     '''
 350     Additional flags to pass to the Yocto toolchain.
 351     '''
 352     if env.get('RELEASE'):
 353         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
 354     if env.get('LOGGING'):
 355         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
 356     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
 357     env.AppendUnique(CFLAGS = ['-std=gnu99'])
 358     env.AppendUnique(CCFLAGS = ['-Wall', '-Wextra', '-fPIC'])
 359     env.AppendUnique(LINKFLAGS = ['-ldl', '-lpthread'])
 360     env.AppendUnique(LIBS = ['uuid'])
 361     Export('env')
 362 else:
 363     '''
 364     If target_os is not Yocto, continue with the regular build process
 365     '''
 366     # Load config of target os
 367     env.SConscript(target_os + '/SConscript')
 368
 369 # Delete the temp files of configuration
 370 if env.GetOption('clean'):
 371         dir = env.get('SRC_DIR')
 372
 373         if os.path.exists(dir + '/config.log'):
 374                 Execute(Delete(dir + '/config.log'))
 375         if os.path.exists(dir + '/.sconsign.dblite'):
 376                 Execute(Delete(dir + '/.sconsign.dblite'))
 377         if os.path.exists(dir + '/.sconf_temp'):
 378                 Execute(Delete(dir + '/.sconf_temp'))
 379
 380 ######################################################################
 381 # Check for PThreads support
 382 ######################################################################
 383 import iotivityconfig
 384 from iotivityconfig import *
 385
 386 conf = Configure(env,
 387         custom_tests =
 388         {
 389             'CheckPThreadsSupport' : iotivityconfig.check_pthreads
 390         } )
 391
 392 # Identify whether we have pthreads support, which is necessary for
 393 # threading and mutexes.  This will set the environment variable
 394 # POSIX_SUPPORTED, 1 if it is supported, 0 otherwise
 395 conf.CheckPThreadsSupport()
 396
 397 env = conf.Finish()
 398 ######################################################################
 399
 400 env.SConscript('external_libs.scons')
 401 Return('env')