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 os
  27
  28 main = Environment()
  29
  30 # Includes which are shared with gem5 itself.
  31 common_include = Dir('..').Dir('..').Dir('include')
  32
  33 src_dir = Dir('src')
  34 build_dir = Dir('build')
  35
  36 def abspath(d):
  37     return os.path.abspath(str(d))
  38
  39 # Universal settings.
  40 main.Append(CCFLAGS=[ '-O2' ])
  41 main.Append(CPPPATH=[ common_include ])
  42
  43 # Propogate the environment's PATH setting.
  44 main['ENV']['PATH'] = os.environ['PATH']
  45
  46 main['CC'] = '${CROSS_COMPILE}gcc'
  47 main['AS'] = '${CROSS_COMPILE}as'
  48 main['LD'] = '${CROSS_COMPILE}ld'
  49 main['AR'] = '${CROSS_COMPILE}ar'
  50
  51 # Detect some dependencies of some forms of the m5 utility/library.
  52 main['HAVE_JAVA'] = all(key in main for key in ('JAVAC', 'JAR'))
  53 main['HAVE_PKG_CONFIG'] = main.Detect('pkg-config') is not None
  54 main['HAVE_LUA51'] = (main['HAVE_PKG_CONFIG'] and
  55                       os.system('pkg-config --exists lua51') == 0)
  56
  57 # Put the sconsign file in the build dir so everything can be deleted at once.
  58 main.SConsignFile(os.path.join(abspath(build_dir), 'sconsign'))
  59 # Use soft links instead of hard links when setting up a build directory.
  60 main.SetOption('duplicate', 'soft-copy')
  61
  62 for root, dirs, files in os.walk(abspath(src_dir)):
  63     # Each SConsopts file describes a variant of the m5 utility.
  64     if 'SConsopts' in files:
  65         env = main.Clone()
  66
  67         # The user may override variant settings by setting environment
  68         # variables of the form ${VARIANT}.${OPTION}. For instance, to set the
  69         # CROSS_COMPILE prefix for variant foo to bar-, the user would set an
  70         # environment variable foo.CROSS_COMPILE=bar-.
  71         #
  72         # This also considers scons command line settings which may look like
  73         # environment variables, but are set after "scons" on the command line.
  74         def get_variant_opt(name, default):
  75             var_name = env.subst('${VARIANT}.%s' % name)
  76             env[name] = os.environ.get(
  77                     var_name, ARGUMENTS.get(var_name, default))
  78
  79         # Process the variant's settings in the SConsopts file, storing them
  80         # in a copy of the primary environment.
  81         env.SConscript(Dir(root).File('SConsopts'),
  82                        exports=[ 'env', 'get_variant_opt' ])
  83
  84         # Once all the options have been configured, set up build targets for
  85         # this variant.
  86         variant_dir = build_dir.Dir(env.subst('${VARIANT}'))
  87         env.SConscript(src_dir.File('SConscript'),
  88                        variant_dir=variant_dir, exports='env')