resource/csdk/connectivity/build/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', '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'],
  19                 'android': ['x86', 'x86_64', 'armeabi', 'armeabi-v7a', 'armeabi-v7a-hard', 'arm64-v8a'],
  20                 'windows': ['x86', 'amd64', 'arm'],
  21                 'darwin': ['i386', 'x86_64'],
  22                 'ios': ['i386', 'x86_64', 'armv7', 'armv7s', 'arm64'],
  23                 'arduino': ['avr', 'arm'],
  24                 'yocto': ['i586', 'i686', 'x86_64', 'arm', 'aarch64', 'powerpc', 'powerpc64', 'mips', 'mipsel'],
  25                 }
  26
  27 host = platform.system().lower()
  28
  29 if not host_target_map.has_key(host):
  30         print "\nError: Current system (%s) isn't supported\n" % host
  31         Exit(1)
  32
  33 ######################################################################
  34 # Get build options (the optins from command line)
  35 ######################################################################
  36 target_os = ARGUMENTS.get('TARGET_OS', host).lower() # target os
  37
  38 if target_os not in host_target_map[host]:
  39         print "\nError: Unknown target os: %s (Allow values: %s)\n" % (target_os, host_target_map[host])
  40         Exit(1)
  41
  42 default_arch = platform.machine()
  43 if default_arch not in os_arch_map[target_os]:
  44         default_arch = os_arch_map[target_os][0].lower()
  45
  46 target_arch = ARGUMENTS.get('TARGET_ARCH', default_arch) # target arch
  47
  48 # True if binary needs to be installed on board. (Might need root permissions)
  49 # set to 'no', 'false' or 0 for only compilation
  50 require_upload = ARGUMENTS.get('UPLOAD', True)
  51
  52 # Get the device name
  53 device_name = ARGUMENTS.get('DEVICE_NAME', "OIC-DEVICE")
  54
  55 ######################################################################
  56 # Common build options (release, target os, target arch)
  57 ######################################################################
  58 help_vars = Variables()
  59 help_vars.Add(BoolVariable('RELEASE', 'Build for release?', True)) # set to 'no', 'false' or 0 for debug
  60 help_vars.Add(BoolVariable('LOGGING', 'Enable stack logging', False))
  61 help_vars.Add(EnumVariable('TARGET_OS', 'Target platform', host, host_target_map[host]))
  62 help_vars.Add(ListVariable('TARGET_TRANSPORT', 'Target transport', 'ALL', ['ALL', 'BT', 'BLE', 'IP']))
  63 help_vars.Add(EnumVariable('TARGET_ARCH', 'Target architecture', default_arch, os_arch_map[target_os]))
  64 help_vars.Add(EnumVariable('SECURED', 'Build with DTLS', '0', allowed_values=('0', '1')))
  65 help_vars.Add(BoolVariable('UPLOAD', 'Upload binary ? (For Arduino)', require_upload))
  66 help_vars.Add(EnumVariable('ROUTING', 'Enable routing', 'EP', allowed_values=('GW', 'EP')))
  67 help_vars.Add(EnumVariable('BUILD_SAMPLE', 'Build with sample', 'ON', allowed_values=('ON', 'OFF')))
  68 help_vars.Add(BoolVariable('WITH_TCP', 'Enable TCP', False))
  69 help_vars.Add(BoolVariable('DISABLE_TCP_SERVER', 'Disable TCP server', False))
  70 help_vars.Add(BoolVariable('DISABLE_BLE_SERVER', 'Disable BLE server', False))
  71 help_vars.Add(ListVariable('WITH_MQ', 'Build with MQ publisher/subscriber/broker', 'OFF', ['OFF', 'SUB', 'PUB', 'BROKER']))
  72
  73 help_vars.AddVariables(('DEVICE_NAME', 'Network display name for device', 'OIC-DEVICE', None, None),)
  74
  75 AddOption('--prefix',
  76                   dest='prefix',
  77                   type='string',
  78                   nargs=1,
  79                   action='store',
  80                   metavar='DIR',
  81                   help='installation prefix')
  82
  83 ######################################################################
  84 # Platform(build target) specific options: SDK/NDK & toolchain
  85 ######################################################################
  86 targets_support_cc = ['linux', 'arduino', 'tizen']
  87
  88 if target_os in targets_support_cc:
  89         # Set cross compile toolchain
  90         help_vars.Add('TC_PREFIX', "Toolchain prefix (Generally only be required for cross-compiling)", os.environ.get('TC_PREFIX'))
  91         help_vars.Add(PathVariable('TC_PATH',
  92                         'Toolchain path (Generally only be required for cross-compiling)',
  93                         os.environ.get('TC_PATH')))
  94
  95 if target_os in ['android', 'arduino']: # Android/Arduino always uses GNU compiler regardless of the host
  96         env = Environment(variables = help_vars,
  97                         tools = ['gnulink', 'gcc', 'g++', 'ar', 'as']
  98                         )
  99 else:
 100         env = Environment(variables = help_vars, TARGET_ARCH = target_arch, TARGET_OS = target_os, PREFIX = GetOption('prefix'))
 101
 102 Help(help_vars.GenerateHelpText(env))
 103
 104 # Set device name to __OIC_DEVICE_NAME__
 105 env.AppendUnique(CPPDEFINES = ['-D__OIC_DEVICE_NAME__=' + "\'\"" + device_name + "\"\'"])
 106
 107 tc_set_msg = '''
 108 ************************************ Warning **********************************
 109 *   Enviornment variable TC_PREFIX/TC_PATH is set. It will change the default *
 110 * toolchain, if it isn't what you expect you should unset it, otherwise it may*
 111 * cause inexplicable errors.                                                  *
 112 *******************************************************************************
 113 '''
 114
 115 if target_os in targets_support_cc:
 116         prefix = env.get('TC_PREFIX')
 117         tc_path = env.get('TC_PATH')
 118         if prefix:
 119                 env.Replace(CC = prefix + 'gcc')
 120                 env.Replace(CXX = prefix + 'g++')
 121                 env.Replace(AR = prefix + 'ar')
 122                 env.Replace(AS = prefix + 'as')
 123                 env.Replace(LINK = prefix + 'ld')
 124                 env.Replace(RANLIB = prefix + 'ranlib')
 125
 126         if tc_path:
 127                 env.PrependENVPath('PATH', tc_path)
 128                 sys_root = os.path.abspath(tc_path + '/../')
 129                 env.AppendUnique(CCFLAGS = ['--sysroot=' + sys_root])
 130                 env.AppendUnique(LINKFLAGS = ['--sysroot=' + sys_root])
 131
 132         if prefix or tc_path:
 133                 print tc_set_msg
 134
 135 # Ensure scons be able to change its working directory
 136 env.SConscriptChdir(1)
 137
 138 # Set the source directory and build directory
 139 #   Source directory: 'dir'
 140 #   Build directory: 'dir'/out/<target_os>/<target_arch>/<release or debug>/
 141 #
 142 # You can get the directory as following:
 143 #   env.get('SRC_DIR')
 144 #   env.get('BUILD_DIR')
 145
 146 def __set_dir(env, dir):
 147         if not os.path.exists(dir + '/SConstruct'):
 148                 print '''
 149 *************************************** Error *********************************
 150 * The directory(%s) seems isn't a source code directory, no SConstruct file is
 151 * found. *
 152 *******************************************************************************
 153 ''' % dir
 154                 Exit(1)
 155
 156         if env.get('RELEASE'):
 157                 build_dir = os.path.join(dir, 'out', target_os, target_arch, 'release') + os.sep
 158         else:
 159                 build_dir = os.path.join(dir, 'out', target_os, target_arch, 'debug') + os.sep
 160         env.VariantDir(build_dir, dir, duplicate=0)
 161
 162         env.Replace(BUILD_DIR = build_dir)
 163         env.Replace(SRC_DIR = dir)
 164
 165 def __src_to_obj(env, src, home = ''):
 166         obj = env.get('BUILD_DIR') + src.replace(home, '')
 167         if env.get('OBJSUFFIX'):
 168                 obj += env.get('OBJSUFFIX')
 169         return env.Object(obj, src)
 170
 171 def __install(ienv, targets, name):
 172         i_n = ienv.Install(env.get('BUILD_DIR'), targets)
 173         Alias(name, i_n)
 174         env.AppendUnique(TS = [name])
 175
 176 def __installlib(ienv, targets, name):
 177         user_prefix = env.get('PREFIX')
 178         if user_prefix:
 179                 install_lib_dir = os.path.join(user_prefix, 'lib')
 180         else:
 181                 install_lib_dir = os.path.join(env.get('BUILD_DIR'), 'lib')
 182         i_n = ienv.Install(install_lib_dir, targets)
 183         ienv.Alias("install", i_n)
 184
 185 def __installbin(ienv, targets, name):
 186         user_prefix = env.get('PREFIX')
 187         if user_prefix:
 188                 i_n = ienv.Install(user_prefix + '/bin', targets)
 189                 ienv.Alias("install", i_n)
 190
 191 def __append_target(ienv, target):
 192         env.AppendUnique(TS = [target])
 193
 194 def __print_targets(env):
 195         Help('''
 196 ===============================================================================
 197 Targets:\n    ''')
 198         for t in env.get('TS'):
 199                 Help(t + ' ')
 200         Help('''
 201 \nDefault all targets will be built. You can specify the target to build:
 202
 203     $ scons [options] [target]
 204 ===============================================================================
 205 ''')
 206
 207 env.AddMethod(__set_dir, 'SetDir')
 208 env.AddMethod(__print_targets, 'PrintTargets')
 209 env.AddMethod(__src_to_obj, 'SrcToObj')
 210 env.AddMethod(__append_target, 'AppendTarget')
 211 env.AddMethod(__install, 'InstallTarget')
 212 env.AddMethod(__installlib, 'UserInstallTargetLib')
 213 env.AddMethod(__installbin, 'UserInstallTargetBin')
 214 env.SetDir(env.GetLaunchDir())
 215 env['ROOT_DIR']=env.GetLaunchDir()+'/..'
 216
 217 Export('env')
 218
 219 ######################################################################
 220 # Link scons to Yocto cross-toolchain ONLY when target_os is yocto
 221 ######################################################################
 222 if target_os == "yocto":
 223     '''
 224     This code injects Yocto cross-compilation tools+flags into scons'
 225     build environment in order to invoke the relevant tools while
 226     performing a build.
 227     '''
 228     import os.path
 229     try:
 230         CC = os.environ['CC']
 231         target_prefix = CC.split()[0]
 232         target_prefix = target_prefix[:len(target_prefix)-3]
 233         tools = {"CC" : target_prefix+"gcc",
 234                 "CXX" : target_prefix+"g++",
 235                 "AS" : target_prefix+"as",
 236                 "LD" : target_prefix+"ld",
 237                 "GDB" : target_prefix+"gdb",
 238                 "STRIP" : target_prefix+"strip",
 239                 "RANLIB" : target_prefix+"ranlib",
 240                 "OBJCOPY" : target_prefix+"objcopy",
 241                 "OBJDUMP" : target_prefix+"objdump",
 242                 "AR" : target_prefix+"ar",
 243                 "NM" : target_prefix+"nm",
 244                 "M4" : "m4",
 245                 "STRINGS": target_prefix+"strings"}
 246         PATH = os.environ['PATH'].split(os.pathsep)
 247         for tool in tools:
 248             if tool in os.environ:
 249                 for path in PATH:
 250                     if os.path.isfile(os.path.join(path, tools[tool])):
 251                         env[tool] = os.path.join(path, os.environ[tool])
 252                         break
 253         env['CROSS_COMPILE'] = target_prefix[:len(target_prefix) - 1]
 254     except:
 255         print "ERROR in Yocto cross-toolchain environment"
 256         Exit(1)
 257     '''
 258     Now reset TARGET_OS to linux so that all linux specific build configurations
 259     hereupon apply for the entirety of the build process.
 260     '''
 261     env['TARGET_OS'] = 'linux'
 262     '''
 263     We want to preserve debug symbols to allow BitBake to generate both DEBUG and
 264     RELEASE packages for OIC.
 265     '''
 266     env.AppendUnique(CCFLAGS = ['-g'])
 267     '''
 268     Additional flags to pass to the Yocto toolchain.
 269     '''
 270     if env.get('RELEASE'):
 271         env.AppendUnique(CPPDEFINES = ['NDEBUG'])
 272     if env.get('LOGGING'):
 273         env.AppendUnique(CPPDEFINES = ['TB_LOG'])
 274     env.AppendUnique(CPPDEFINES = ['WITH_POSIX', '__linux__', '_GNU_SOURCE'])
 275     env.AppendUnique(CFLAGS = ['-std=gnu99'])
 276     env.AppendUnique(CCFLAGS = ['-Wall', '-fPIC'])
 277     if target_os in ['linux']:
 278         env.AppendUnique(LIBS = ['dl', 'pthread'])
 279     Export('env')
 280 else:
 281     '''
 282     If target_os is not Yocto, continue with the regular build process
 283     '''
 284     # Load config of target os
 285     if target_os in ['linux', 'tizen']:
 286                 env.SConscript('linux/SConscript')
 287     else:
 288                 env.SConscript(target_os + '/SConscript')
 289
 290 # Delete the temp files of configuration
 291 if env.GetOption('clean'):
 292         dir = env.get('SRC_DIR')
 293
 294         if os.path.exists(dir + '/config.log'):
 295                 Execute(Delete(dir + '/config.log'))
 296                 Execute(Delete(dir + '/.sconsign.dblite'))
 297                 Execute(Delete(dir + '/.sconf_temp'))
 298
 299 Return('env')