SConstruct revision 1762 
1# -*- mode:python -*-
2
3# Copyright (c) 2004-2005 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# 'ALPHA_FS/m5.opt' for the optimized full-system version).
41#
42###################################################
43
44# Python library imports
45import sys
46import os
47
48# The absolute path to the current directory (where this file lives).
49ROOT = Dir('.').abspath
50
51# Paths to the M5 and external source trees (local symlinks).
52SRCDIR = os.path.join(ROOT, 'm5')
53EXT_SRCDIR = os.path.join(ROOT, 'ext')
54
55# Check for 'm5' and 'ext' links, die if they don't exist.
56if not os.path.isdir(SRCDIR):
57    print "Error: '%s' must be a link to the M5 source tree." % SRCDIR
58    sys.exit(1)
59
60if 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
66sys.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_SE or ALPHA_FS) 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.
91def AlphaSyscallEmulConfig(env):
92    env.Replace(TARGET_ISA = 'alpha')
93    env.Append(CPPDEFINES = 'SS_COMPATIBLE_FP')
94
95# Base full-system configuration.
96def AlphaFullSysConfig(env):
97    env.Replace(TARGET_ISA = 'alpha')
98    env.Replace(FULL_SYSTEM = True)
99    env.Append(CPPDEFINES = ['FULL_SYSTEM'])
100
101# Base configurations map.
102configs_map = {
103    'ALPHA_SE' : AlphaSyscallEmulConfig,
104    'ALPHA_FS' : AlphaFullSysConfig
105    }
106
107# Disable FastAlloc object allocation.
108def NoFastAllocOpt(env):
109    env.Append(CPPDEFINES = 'NO_FAST_ALLOC')
110
111# Enable efence
112def EfenceOpt(env):
113    env.Append(LIBS=['efence'])
114
115# Configuration options map.
116options_map = {
117    'NO_FAST_ALLOC' : NoFastAllocOpt,
118    'EFENCE' : EfenceOpt
119    }
120
121# The 'local_configs' file can be used to define additional base
122# configurations and/or options without changing this file.
123if os.path.isfile('local_configs'):
124    SConscript('local_configs', exports = ['configs_map', 'options_map'])
125
126# This function parses a directory name of the form <CONFIG>[.<OPT>]*
127# and sets up the build environment appropriately.  Returns True if
128# successful, False if the base config or any of the options were not
129# defined.
130def set_dir_options(dir, env):
131    parts = dir.split('.')
132    config = parts[0]
133    opts = parts[1:]
134    try:
135        configs_map[config](env)
136        map(lambda opt: options_map[opt](env), opts)
137        return True
138    except KeyError, key:
139        print "Config/option '%s' not found." % key
140        return False
141
142# Set the default configuration and binary.  The default target (if
143# scons is invoked at the top level with no command-line targets) is
144# 'ALPHA_SE/m5.debug'.  If scons is invoked in a subdirectory with no
145# command-line targets, the configuration
146
147###################################################
148#
149# Figure out which configurations to set up.
150#
151#
152# It's prohibitive to do all the combinations of base configurations
153# and options, so we have to infer which ones the user wants.
154#
155# 1. If there are command-line targets, the configuration(s) are inferred
156#    from the directories of those targets.  If scons was invoked from a
157#    subdirectory (using 'scons -u'), those targets have to be
158#    interpreted relative to that subdirectory.
159#
160# 2. If there are no command-line targets, and scons was invoked from a
161#    subdirectory (using 'scons -u'), the configuration is inferred from
162#    the name of the subdirectory.
163#
164# 3. If there are no command-line targets and scons was invoked from
165#    the root build directory, a default configuration is used.  The
166#    built-in default is ALPHA_SE, but this can be overridden by setting the
167#    M5_DEFAULT_CONFIG shell environment veriable.
168#
169# In cases 2 & 3, the specific file target defaults to 'm5.debug', but
170# this can be overridden by setting the M5_DEFAULT_BINARY shell
171# environment veriable.
172#
173###################################################
174
175# Find default configuration & binary.
176default_config = os.environ.get('M5_DEFAULT_CONFIG', 'ALPHA_SE')
177default_binary = os.environ.get('M5_DEFAULT_BINARY', 'm5.debug')
178
179# Ask SCons which directory it was invoked from.  If you invoke SCons
180# from a subdirectory you must use the '-u' flag.
181launch_dir = GetLaunchDir()
182
183# Build a list 'my_targets' of all the targets relative to ROOT.
184if launch_dir == ROOT:
185    # invoked from root build dir
186    if len(COMMAND_LINE_TARGETS) != 0:
187        # easy: use specified targets as is
188        my_targets = COMMAND_LINE_TARGETS
189    else:
190        # default target (ALPHA_SE/m5.debug, unless overridden)
191        target = os.path.join(default_config, default_binary)
192        my_targets = [target]
193        Default(target)
194else:
195    # invoked from subdirectory
196    if not launch_dir.startswith(ROOT):
197        print "Error: launch dir (%s) not a subdirectory of ROOT (%s)!" \
198              (launch_dir, ROOT)
199        sys.exit(1)
200    # make launch_dir relative to ROOT (strip ROOT plus slash off front)
201    launch_dir = launch_dir[len(ROOT)+1:]
202    if len(COMMAND_LINE_TARGETS) != 0:
203        # make specified targets relative to ROOT
204        my_targets = map(lambda x: os.path.join(launch_dir, x),
205                         COMMAND_LINE_TARGETS)
206    else:
207        # build default binary (m5.debug, unless overridden) using the
208        # config inferred by the invocation directory (the first
209        # subdirectory after ROOT)
210        target = os.path.join(launch_dir.split('/')[0], default_binary)
211        my_targets = [target]
212        Default(target)
213
214# Normalize target paths (gets rid of '..' in the middle, etc.)
215my_targets = map(os.path.normpath, my_targets)
216
217# Generate a list of the unique configs that the collected targets reference.
218build_dirs = []
219for t in my_targets:
220    dir = t.split('/')[0]
221    if dir not in build_dirs:
222        build_dirs.append(dir)
223
224###################################################
225#
226# Set up the default build environment.  This environment is copied
227# and modified according to each selected configuration.
228#
229###################################################
230
231default_env = Environment(ENV = os.environ,  # inherit user's enviroment vars
232                          ROOT = ROOT,
233                          SRCDIR = SRCDIR,
234                          EXT_SRCDIR = EXT_SRCDIR,
235                          CPPDEFINES = [],
236                          FULL_SYSTEM = False,
237                          ALPHA_TLASER = False,
238                          USE_MYSQL = False)
239
240default_env.SConsignFile("sconsign")
241
242# For some reason, the CC and CXX variables don't get passed into the
243# environment correctly.  This is probably some sort of scons bug that
244# will eventually be fixed.
245if os.environ.has_key('CC'):
246    default_env.Replace(CC=os.environ['CC'])
247
248if os.environ.has_key('CXX'):
249    default_env.Replace(CXX=os.environ['CXX'])
250
251# M5_EXT is used by isa_parser.py to find the PLY package.
252default_env.Append(ENV = { 'M5_EXT' : EXT_SRCDIR })
253
254default_env.Append(CCFLAGS='-pipe')
255default_env.Append(CCFLAGS='-fno-strict-aliasing')
256default_env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
257default_env.Append(CPPPATH=[os.path.join(EXT_SRCDIR + '/dnet')])
258
259# libelf build is described in its own SConscript file.  Using a
260# dictionary for exports lets us export "default_env" so the
261# SConscript will see it as "env".  SConscript-global is the build in
262# build/libelf shared among all configs.
263default_env.SConscript('m5/libelf/SConscript-global',
264                       exports={'env' : default_env})
265
266###################################################
267#
268# Define build environments for selected configurations.
269#
270###################################################
271
272for build_dir in build_dirs:
273    # Make a copy of the default environment to use for this config.
274    env = default_env.Copy()
275    # Modify 'env' according to the build directory config.
276    print "Configuring options for directory '%s'." % build_dir
277    if not set_dir_options(build_dir, env):
278        print "Skipping directory '%s'." % build_dir
279        continue
280
281    # The m5/SConscript file sets up the build rules in 'env' according
282    # to the configured options.
283    SConscript('m5/SConscript', build_dir = build_dir, exports = 'env',
284               duplicate=0)
285
286
287###################################################
288#
289# Let SCons do its thing.  At this point SCons will use the defined
290# build environments to build the requested targets.
291#
292###################################################
293
294