util/m5/SConstruct

   1 # Copyright 2020 Google, Inc.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are
   5 # met: redistributions of source code must retain the above copyright
   6 # notice, this list of conditions and the following disclaimer;
   7 # redistributions in binary form must reproduce the above copyright
   8 # notice, this list of conditions and the following disclaimer in the
   9 # documentation and/or other materials provided with the distribution;
  10 # neither the name of the copyright holders nor the names of its
  11 # contributors may be used to endorse or promote products derived from
  12 # this software without specific prior written permission.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 import copy
  27 import os
  28
  29 main = Environment()
  30
  31 # Includes which are shared with gem5 itself.
  32 common_include = Dir('..').Dir('..').Dir('include')
  33
  34 src_dir = Dir('src')
  35 build_dir = Dir('build')
  36
  37 def abspath(d):
  38     return os.path.abspath(str(d))
  39
  40 # Universal settings.
  41 main.Append(CXXFLAGS=[ '-O2' ])
  42 main.Append(CCFLAGS=[ '-O2' ])
  43 main.Append(CPPPATH=[ common_include ])
  44
  45 # Propogate the environment's PATH setting.
  46 main['ENV']['PATH'] = os.environ['PATH']
  47
  48 main['CC'] = '${CROSS_COMPILE}gcc'
  49 main['CXX'] = '${CROSS_COMPILE}g++'
  50 main['AS'] = '${CROSS_COMPILE}as'
  51 main['LD'] = '${CROSS_COMPILE}ld'
  52 main['AR'] = '${CROSS_COMPILE}ar'
  53
  54 # Detect some dependencies of some forms of the m5 utility/library.
  55 main['HAVE_JAVA'] = all(key in main for key in ('JAVAC', 'JAR'))
  56 main['HAVE_PKG_CONFIG'] = main.Detect('pkg-config') is not None
  57 main['HAVE_LUA51'] = (main['HAVE_PKG_CONFIG'] and
  58                       os.system('pkg-config --exists lua51') == 0)
  59
  60 # Put the sconsign file in the build dir so everything can be deleted at once.
  61 main.SConsignFile(os.path.join(abspath(build_dir), 'sconsign'))
  62 # Use soft links instead of hard links when setting up a build directory.
  63 main.SetOption('duplicate', 'soft-copy')
  64
  65 class CallType(object):
  66     def __init__(self, name):
  67         self.name = name
  68         self.impl_file = None
  69         self.enabled = False
  70         self.default = False
  71
  72     def impl(self, impl, default=False):
  73         self.impl_file = impl
  74         self.enabled = True
  75         self.default = default
  76
  77 call_types = {
  78     # Magic instruction.
  79     'inst': CallType('inst'),
  80     # Magic address.
  81     'addr': CallType('addr'),
  82     # Semihosting extension.
  83     'semi': CallType('semi'),
  84 }
  85
  86 for root, dirs, files in os.walk(abspath(src_dir)):
  87     # Each SConsopts file describes a variant of the m5 utility.
  88     if 'SConsopts' in files:
  89         env = main.Clone()
  90
  91         env['CALL_TYPE'] = copy.deepcopy(call_types)
  92
  93         # The user may override variant settings by setting environment
  94         # variables of the form ${VARIANT}.${OPTION}. For instance, to set the
  95         # CROSS_COMPILE prefix for variant foo to bar-, the user would set an
  96         # environment variable foo.CROSS_COMPILE=bar-.
  97         #
  98         # This also considers scons command line settings which may look like
  99         # environment variables, but are set after "scons" on the command line.
 100         def get_variant_opt(name, default):
 101             var_name = env.subst('${VARIANT}.%s' % name)
 102             env[name] = os.environ.get(
 103                     var_name, ARGUMENTS.get(var_name, default))
 104
 105         # Process the variant's settings in the SConsopts file, storing them
 106         # in a copy of the primary environment.
 107         env.SConscript(Dir(root).File('SConsopts'),
 108                        exports=[ 'env', 'get_variant_opt' ])
 109
 110         # Once all the options have been configured, set up build targets for
 111         # this variant.
 112         variant_dir = build_dir.Dir(env.subst('${VARIANT}'))
 113         env.SConscript(src_dir.File('SConscript'),
 114                        variant_dir=variant_dir, exports='env')