build/SConstruct

   1 # -*- mode:python -*-
   2
   3 # Copyright (c) 2004 The Regents of The University of Michigan
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are
   8 # met: redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer;
  10 # redistributions in binary form must reproduce the above copyright
  11 # notice, this list of conditions and the following disclaimer in the
  12 # documentation and/or other materials provided with the distribution;
  13 # neither the name of the copyright holders nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 ###################################################
  30 #
  31 # SCons top-level build description (SConstruct) file.
  32 #
  33 # To build M5, you need a directory with three things:
  34 # 1. A copy of this file (named SConstruct).
  35 # 2. A link named 'm5' to the top of the M5 simulator source tree.
  36 # 3. A link named 'ext' to the top of the M5 external source tree.
  37 #
  38 # Then type 'scons' to build the default configuration (see below), or
  39 # 'scons <CONFIG>/<binary>' to build some other configuration (e.g.,
  40 # 'KERNEL/m5.opt' for the optimized full-system version).
  41 #
  42 ###################################################
  43
  44 # Python library imports
  45 import sys
  46 import os
  47
  48 # The absolute path to the current directory (where this file lives).
  49 ROOT = Dir('.').abspath
  50
  51 # Paths to the M5 and external source trees (local symlinks).
  52 SRCDIR = os.path.join(ROOT, 'm5')
  53 EXT_SRCDIR = os.path.join(ROOT, 'ext')
  54
  55 # Check for 'm5' and 'ext' links, die if they don't exist.
  56 if not os.path.isdir(SRCDIR):
  57     print "Error: '%s' must be a link to the M5 source tree." % SRCDIR
  58     sys.exit(1)
  59
  60 if not os.path.isdir('ext'):
  61     print "Error: '%s' must be a link to the M5 external source tree." \
  62           % EXT_SRCDIR
  63     sys.exit(1)
  64
  65 # tell python where to find m5 python code
  66 sys.path.append(os.path.join(SRCDIR, 'python'))
  67
  68
  69 ###################################################
  70 #
  71 # Define Configurations
  72 #
  73 # The build system infers the build options from the subdirectory name
  74 # that the simulator is built under.  The subdirectory name must be of
  75 # the form <CONFIG>[.<OPT>]*, where <CONFIG> is a base configuration
  76 # (e.g., ALPHA or KERNEL) and OPT is an option (e.g., MYSQL).  The
  77 # following code defines the standard configurations and options.
  78 # Additional local configurations and options are read from the file
  79 # 'local_configs' if it exists.
  80 #
  81 # Each base configuration or option is defined in two steps: a
  82 # function that takes an SCons build environment and modifies it
  83 # appropriately for that config or option, and an entry in the
  84 # 'configs_map' or 'options_map' dictionary that maps the directory
  85 # name string to the function.  (The directory names are all upper
  86 # case, by convention.)
  87 #
  88 ###################################################
  89
  90 # Base non-full-system Alpha ISA configuration.
  91 def AlphaConfig(env):
  92     env.Replace(TARGET_ISA = 'alpha')
  93     env.Append(CPPDEFINES = 'SS_COMPATIBLE_FP')
  94
  95 # Base full-system configuration.
  96 def KernelConfig(env):
  97     env.Replace(TARGET_ISA = 'alpha')
  98     env.Replace(FULL_SYSTEM = True)
  99     env.Append(CPPDEFINES = ['FULL_SYSTEM'])
 100
 101 # Base configurations map.
 102 configs_map = {
 103     'ALPHA' : AlphaConfig,
 104     'KERNEL' : KernelConfig
 105     }
 106
 107 # Enable detailed full-system binning.
 108 def MeasureOpt(env):
 109     env.Replace(USE_MYSQL = True)
 110     env.Append(CPPDEFINES = 'FS_MEASURE')
 111
 112 # Enable MySql database output for stats.
 113 def MySqlOpt(env):
 114     env.Replace(USE_MYSQL = True)
 115
 116 # Disable FastAlloc object allocation.
 117 def NoFastAllocOpt(env):
 118     env.Append(CPPDEFINES = 'NO_FAST_ALLOC')
 119
 120 # Enable efence
 121 def EfenceOpt(env):
 122     env.Append(LIBS=['efence'])
 123
 124 # Configuration options map.
 125 options_map = {
 126     'MEASURE' : MeasureOpt,
 127     'MYSQL' : MySqlOpt,
 128     'NO_FAST_ALLOC' : NoFastAllocOpt,
 129     'EFENCE' : EfenceOpt
 130     }
 131
 132 # The 'local_configs' file can be used to define additional base
 133 # configurations and/or options without changing this file.
 134 if os.path.isfile('local_configs'):
 135     SConscript('local_configs', exports = ['configs_map', 'options_map'])
 136
 137 # This function parses a directory name of the form <CONFIG>[.<OPT>]*
 138 # and sets up the build environment appropriately.  Returns True if
 139 # successful, False if the base config or any of the options were not
 140 # defined.
 141 def set_dir_options(dir, env):
 142     parts = dir.split('.')
 143     config = parts[0]
 144     opts = parts[1:]
 145     try:
 146         configs_map[config](env)
 147         map(lambda opt: options_map[opt](env), opts)
 148         return True
 149     except KeyError, key:
 150         print "Config/option '%s' not found." % key
 151         return False
 152
 153 # Set the default configuration and binary.  The default target (if
 154 # scons is invoked at the top level with no command-line targets) is
 155 # 'ALPHA/m5.debug'.  If scons is invoked in a subdirectory with no
 156 # command-line targets, the configuration
 157
 158 ###################################################
 159 #
 160 # Figure out which configurations to set up.
 161 #
 162 #
 163 # It's prohibitive to do all the combinations of base configurations
 164 # and options, so we have to infer which ones the user wants.
 165 #
 166 # 1. If there are command-line targets, the configuration(s) are inferred
 167 #    from the directories of those targets.  If scons was invoked from a
 168 #    subdirectory (using 'scons -u'), those targets have to be
 169 #    interpreted relative to that subdirectory.
 170 #
 171 # 2. If there are no command-line targets, and scons was invoked from a
 172 #    subdirectory (using 'scons -u'), the configuration is inferred from
 173 #    the name of the subdirectory.
 174 #
 175 # 3. If there are no command-line targets and scons was invoked from
 176 #    the root build directory, a default configuration is used.  The
 177 #    built-in default is ALPHA, but this can be overridden by setting the
 178 #    M5_DEFAULT_CONFIG shell environment veriable.
 179 #
 180 # In cases 2 & 3, the specific file target defaults to 'm5.debug', but
 181 # this can be overridden by setting the M5_DEFAULT_BINARY shell
 182 # environment veriable.
 183 #
 184 ###################################################
 185
 186 # Find default configuration & binary.
 187 default_config = os.environ.get('M5_DEFAULT_CONFIG', 'ALPHA')
 188 default_binary = os.environ.get('M5_DEFAULT_BINARY', 'm5.debug')
 189
 190 # Ask SCons which directory it was invoked from.  If you invoke SCons
 191 # from a subdirectory you must use the '-u' flag.
 192 launch_dir = GetLaunchDir()
 193
 194 # Build a list 'my_targets' of all the targets relative to ROOT.
 195 if launch_dir == ROOT:
 196     # invoked from root build dir
 197     if len(COMMAND_LINE_TARGETS) != 0:
 198         # easy: use specified targets as is
 199         my_targets = COMMAND_LINE_TARGETS
 200     else:
 201         # default target (ALPHA/m5.debug, unless overridden)
 202         target = os.path.join(default_config, default_binary)
 203         my_targets = [target]
 204         Default(target)
 205 else:
 206     # invoked from subdirectory
 207     if not launch_dir.startswith(ROOT):
 208         print "Error: launch dir (%s) not a subdirectory of ROOT (%s)!" \
 209               (launch_dir, ROOT)
 210         sys.exit(1)
 211     # make launch_dir relative to ROOT (strip ROOT plus slash off front)
 212     launch_dir = launch_dir[len(ROOT)+1:]
 213     if len(COMMAND_LINE_TARGETS) != 0:
 214         # make specified targets relative to ROOT
 215         my_targets = map(lambda x: os.path.join(launch_dir, x),
 216                          COMMAND_LINE_TARGETS)
 217     else:
 218         # build default binary (m5.debug, unless overridden) using the
 219         # config inferred by the invocation directory (the first
 220         # subdirectory after ROOT)
 221         target = os.path.join(launch_dir.split('/')[0], default_binary)
 222         my_targets = [target]
 223         Default(target)
 224
 225 # Normalize target paths (gets rid of '..' in the middle, etc.)
 226 my_targets = map(os.path.normpath, my_targets)
 227
 228 # Generate a list of the unique configs that the collected targets reference.
 229 build_dirs = []
 230 for t in my_targets:
 231     dir = t.split('/')[0]
 232     if dir not in build_dirs:
 233         build_dirs.append(dir)
 234
 235 ###################################################
 236 #
 237 # Set up the default build environment.  This environment is copied
 238 # and modified according to each selected configuration.
 239 #
 240 ###################################################
 241
 242 default_env = Environment(ENV = os.environ,  # inherit user's enviroment vars
 243                           ROOT = ROOT,
 244                           SRCDIR = SRCDIR,
 245                           EXT_SRCDIR = EXT_SRCDIR,
 246                           CPPDEFINES = [],
 247                           FULL_SYSTEM = False,
 248                           USE_MYSQL = False)
 249
 250 default_env.SConsignFile("sconsign")
 251
 252 # For some reason, the CC and CXX variables don't get passed into the
 253 # environment correctly.  This is probably some sort of scons bug that
 254 # will eventually be fixed.
 255 if os.environ.has_key('CC'):
 256     default_env.Replace(CC=os.environ['CC'])
 257
 258 if os.environ.has_key('CXX'):
 259     default_env.Replace(CXX=os.environ['CXX'])
 260
 261 # M5_EXT is used by isa_parser.py to find the PLY package.
 262 default_env.Append(ENV = { 'M5_EXT' : EXT_SRCDIR })
 263
 264 default_env.Append(CCFLAGS='-pipe')
 265 default_env.Append(CCFLAGS='-fno-strict-aliasing')
 266 default_env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
 267 default_env.Append(CPPPATH=[os.path.join(EXT_SRCDIR + '/dnet')])
 268
 269 # libelf build is described in its own SConscript file.  Using a
 270 # dictionary for exports lets us export "default_env" so the
 271 # SConscript will see it as "env".  SConscript-global is the build in
 272 # build/libelf shared among all configs.
 273 default_env.SConscript('m5/libelf/SConscript-global',
 274                        exports={'env' : default_env})
 275
 276 ###################################################
 277 #
 278 # Define build environments for selected configurations.
 279 #
 280 ###################################################
 281
 282 for build_dir in build_dirs:
 283     # Make a copy of the default environment to use for this config.
 284     env = default_env.Copy()
 285     # Modify 'env' according to the build directory config.
 286     print "Configuring options for directory '%s'." % build_dir
 287     if not set_dir_options(build_dir, env):
 288         print "Skipping directory '%s'." % build_dir
 289         continue
 290
 291     # The m5/SConscript file sets up the build rules in 'env' according
 292     # to the configured options.
 293     SConscript('m5/SConscript', build_dir = build_dir, exports = 'env',
 294                duplicate=0)
 295
 296
 297 ###################################################
 298 #
 299 # Let SCons do its thing.  At this point SCons will use the defined
 300 # build environments to build the requested targets.
 301 #
 302 ###################################################
 303