SConscript revision 3683
1955SN/A# -*- mode:python -*-
2955SN/A
31762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
4955SN/A# All rights reserved.
5955SN/A#
6955SN/A# Redistribution and use in source and binary forms, with or without
7955SN/A# modification, are permitted provided that the following conditions are
8955SN/A# met: redistributions of source code must retain the above copyright
9955SN/A# notice, this list of conditions and the following disclaimer;
10955SN/A# redistributions in binary form must reproduce the above copyright
11955SN/A# notice, this list of conditions and the following disclaimer in the
12955SN/A# documentation and/or other materials provided with the distribution;
13955SN/A# neither the name of the copyright holders nor the names of its
14955SN/A# contributors may be used to endorse or promote products derived from
15955SN/A# this software without specific prior written permission.
16955SN/A#
17955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282665Ssaidi@eecs.umich.edu#
292665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
30955SN/A
31955SN/Aimport os
32955SN/Aimport sys
333583Sbinkertn@umich.edufrom os.path import isfile, join as joinpath
34955SN/A
35955SN/A# This file defines how to build a particular configuration of M5
36955SN/A# based on variable settings in the 'env' build environment.
37955SN/A
38955SN/A# Import build environment variable from SConstruct.
39955SN/AImport('env')
40955SN/A
41955SN/A###################################################
42955SN/A#
43955SN/A# Define needed sources.
44955SN/A#
45955SN/A###################################################
46955SN/A
47955SN/A# Base sources used by all configurations.
482023SN/A
49955SN/Abase_sources = Split('''
503089Ssaidi@eecs.umich.edu	base/annotate.cc
51955SN/A	base/circlebuf.cc
52955SN/A	base/cprintf.cc
53955SN/A	base/fast_alloc.cc
54955SN/A	base/fifo_buffer.cc
55955SN/A	base/hostinfo.cc
56955SN/A	base/hybrid_pred.cc
57955SN/A	base/inifile.cc
58955SN/A	base/intmath.cc
591031SN/A	base/match.cc
60955SN/A	base/misc.cc
611388SN/A	base/output.cc
62955SN/A	base/pollevent.cc
63955SN/A	base/range.cc
641296SN/A	base/random.cc
65955SN/A	base/sat_counter.cc
66955SN/A	base/socket.cc
67955SN/A	base/statistics.cc
68955SN/A	base/str.cc
69955SN/A	base/time.cc
70955SN/A	base/trace.cc
71955SN/A	base/traceflags.cc
72955SN/A	base/userinfo.cc
73955SN/A	base/compression/lzss_compression.cc
74955SN/A	base/loader/aout_object.cc
75955SN/A	base/loader/ecoff_object.cc
76955SN/A	base/loader/elf_object.cc
773584Ssaidi@eecs.umich.edu	base/loader/raw_object.cc
78955SN/A	base/loader/object_file.cc
79955SN/A	base/loader/symtab.cc
80955SN/A	base/stats/events.cc
81955SN/A	base/stats/statdb.cc
82955SN/A	base/stats/visit.cc
83955SN/A	base/stats/text.cc
84955SN/A
852325SN/A        cpu/activity.cc
861717SN/A	cpu/base.cc
872652Ssaidi@eecs.umich.edu	cpu/cpuevent.cc
88955SN/A	cpu/exetrace.cc
892736Sktlim@umich.edu        cpu/func_unit.cc
902410SN/A        cpu/op_class.cc
91955SN/A	cpu/pc_event.cc
922290SN/A        cpu/quiesce_event.cc
93955SN/A	cpu/static_inst.cc
942683Sktlim@umich.edu        cpu/simple_thread.cc
952683Sktlim@umich.edu        cpu/thread_state.cc
962669Sktlim@umich.edu
972568SN/A        mem/bridge.cc
982568SN/A        mem/bus.cc
993012Ssaidi@eecs.umich.edu        mem/dram.cc
1002462SN/A        mem/mem_object.cc
1012568SN/A        mem/packet.cc
1022395SN/A        mem/physical.cc
1032405SN/A        mem/port.cc
1042914Ssaidi@eecs.umich.edu        mem/tport.cc
105955SN/A
1062811Srdreslin@umich.edu        mem/cache/base_cache.cc
1072811Srdreslin@umich.edu        mem/cache/cache.cc
1082811Srdreslin@umich.edu        mem/cache/coherence/coherence_protocol.cc
1092811Srdreslin@umich.edu        mem/cache/coherence/uni_coherence.cc
1102811Srdreslin@umich.edu        mem/cache/miss/blocking_buffer.cc
1112811Srdreslin@umich.edu        mem/cache/miss/miss_queue.cc
1122811Srdreslin@umich.edu        mem/cache/miss/mshr.cc
1132811Srdreslin@umich.edu        mem/cache/miss/mshr_queue.cc
1142811Srdreslin@umich.edu        mem/cache/prefetch/base_prefetcher.cc
1152811Srdreslin@umich.edu        mem/cache/prefetch/ghb_prefetcher.cc
1162811Srdreslin@umich.edu        mem/cache/prefetch/prefetcher.cc
1172811Srdreslin@umich.edu        mem/cache/prefetch/stride_prefetcher.cc
1182811Srdreslin@umich.edu        mem/cache/prefetch/tagged_prefetcher.cc
1192811Srdreslin@umich.edu        mem/cache/tags/base_tags.cc
1202811Srdreslin@umich.edu        mem/cache/tags/cache_tags.cc
1212811Srdreslin@umich.edu        mem/cache/tags/fa_lru.cc
1222814Srdreslin@umich.edu        mem/cache/tags/iic.cc
1232811Srdreslin@umich.edu        mem/cache/tags/lru.cc
1242811Srdreslin@umich.edu        mem/cache/tags/repl/gen.cc
1252811Srdreslin@umich.edu        mem/cache/tags/repl/repl.cc
1262811Srdreslin@umich.edu        mem/cache/tags/split.cc
1272811Srdreslin@umich.edu        mem/cache/tags/split_lifo.cc
1282811Srdreslin@umich.edu        mem/cache/tags/split_lru.cc
1292811Srdreslin@umich.edu
1302813Srdreslin@umich.edu        mem/cache/cache_builder.cc
1312813Srdreslin@umich.edu
1323645Sbinkertn@umich.edu        python/swig/debug_wrap.cc
1333624Sbinkertn@umich.edu        python/swig/main_wrap.cc
1343624Sbinkertn@umich.edu
135955SN/A	sim/builder.cc
136955SN/A	sim/debug.cc
137955SN/A	sim/eventq.cc
1382090SN/A	sim/faults.cc
139955SN/A	sim/main.cc
140955SN/A	sim/param.cc
1411696SN/A	sim/root.cc
142955SN/A	sim/serialize.cc
143955SN/A	sim/sim_events.cc
144955SN/A	sim/sim_object.cc
1451127SN/A	sim/startup.cc
146955SN/A	sim/stat_context.cc
147955SN/A	sim/stat_control.cc
1482379SN/A	sim/system.cc
149955SN/A	sim/trace_context.cc
150955SN/A        ''')
151955SN/A
1522422SN/Atrace_reader_sources = Split('''
1532422SN/A        cpu/trace/reader/mem_trace_reader.cc
1542422SN/A        cpu/trace/reader/ibm_reader.cc
1552422SN/A        cpu/trace/reader/itx_reader.cc
1562422SN/A        cpu/trace/reader/m5_reader.cc
1572422SN/A        cpu/trace/opt_cpu.cc
1582422SN/A        cpu/trace/trace_cpu.cc
1592397SN/A        ''')
1602397SN/A
1612422SN/A
1622422SN/A
163955SN/A# MySql sources
164955SN/Amysql_sources = Split('''
165955SN/A	base/mysql.cc
166955SN/A	base/stats/mysql.cc
167955SN/A        ''')
168955SN/A
169955SN/A# Full-system sources
170955SN/Afull_system_sources = Split('''
1711078SN/A	base/crc.cc
172955SN/A	base/inet.cc
173955SN/A	base/remote_gdb.cc
174955SN/A
175955SN/A	cpu/intr_control.cc
1761917SN/A        cpu/profile.cc
177955SN/A
178955SN/A	dev/uart.cc
1791730SN/A	dev/uart8250.cc
180955SN/A
1812521SN/A        mem/vport.cc
1822521SN/A
1832507SN/A	sim/pseudo_inst.cc
1842507SN/A        ''')
1852989Ssaidi@eecs.umich.edu	#dev/sinic.cc
1863408Ssaidi@eecs.umich.edu        #dev/i8254xGBe.cc
1872507SN/A
1882507SN/Aif env['TARGET_ISA'] == 'alpha':
1892507SN/A    full_system_sources += Split('''
190955SN/A	kern/tru64/dump_mbuf.cc
191955SN/A	kern/tru64/printf.cc
192955SN/A	kern/tru64/tru64_events.cc
193955SN/A	kern/tru64/tru64_syscalls.cc
194955SN/A        ''')
195955SN/A
196955SN/A# Syscall emulation (non-full-system) sources
197955SN/Asyscall_emulation_sources = Split('''
1982520SN/A        mem/translating_port.cc
1992517SN/A        mem/page_table.cc
2002253SN/A	sim/process.cc
2012253SN/A	sim/syscall_emul.cc
2022253SN/A        ''')
2032253SN/A
2042553SN/A#if env['TARGET_ISA'] == 'alpha':
2052553SN/A#    syscall_emulation_sources += Split('''
2062553SN/A#        kern/tru64/tru64.cc
2072553SN/A#        ''')
2082507SN/A
2092400SN/Amemtest_sources = Split('''
2102400SN/A	cpu/memtest/memtest.cc
211955SN/A        ''')
212955SN/A
2132667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2142667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2152667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2162667Sstever@eecs.umich.edu# files.
2172667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2182667Sstever@eecs.umich.edu
2192037SN/A# Add a flag defining what THE_ISA should be for all compilation
2202037SN/Aenv.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
2212037SN/A
2223534Sgblack@eecs.umich.eduarch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
2232139SN/A
2243534Sgblack@eecs.umich.educpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
2253534Sgblack@eecs.umich.edu
2263542Sgblack@eecs.umich.eduif env['FULL_SYSTEM']:
2273583Sbinkertn@umich.edu    dev_sources = SConscript(os.path.join('dev', 'SConscript'),
2283583Sbinkertn@umich.edu                             exports = 'env')
2293542Sgblack@eecs.umich.edu    full_system_sources += dev_sources
2303499Ssaidi@eecs.umich.edu
2313583Sbinkertn@umich.edu    kern_sources = SConscript(os.path.join('kern', 'SConscript'),
2323583Sbinkertn@umich.edu                              exports = 'env')
2333547Sgblack@eecs.umich.edu    full_system_sources += kern_sources
2342155SN/A
235955SN/A# Set up complete list of sources based on configuration.
2362155SN/Asources = base_sources + arch_sources + cpu_sources
237955SN/A
2383583Sbinkertn@umich.edu# encumbered should be last because we're adding to some of the other groups
2393583Sbinkertn@umich.eduif isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
2403583Sbinkertn@umich.edu    sources += SConscript('encumbered/SConscript', exports = 'env')
2413583Sbinkertn@umich.edu
2423583Sbinkertn@umich.edu
243955SN/Aif env['FULL_SYSTEM']:
244955SN/A    sources += full_system_sources
245955SN/Aelse:
246955SN/A    sources += syscall_emulation_sources
247955SN/A
2481858SN/Aif env['USE_MYSQL']:
249955SN/A    sources += mysql_sources
2501858SN/A
2511858SN/Afor opt in env.ExportOptions:
2521858SN/A    env.ConfigFile(opt)
2531085SN/A
254955SN/A###################################################
255955SN/A#
256955SN/A# Special build rules.
257955SN/A#
258955SN/A###################################################
259955SN/A
260955SN/A# base/traceflags.{cc,hh} are generated from base/traceflags.py.
261955SN/A# $TARGET.base will expand to "<build-dir>/base/traceflags".
262955SN/Aenv.Command(Split('base/traceflags.hh base/traceflags.cc'),
263955SN/A            'base/traceflags.py',
264955SN/A            'python $SOURCE $TARGET.base')
265955SN/A
2662667Sstever@eecs.umich.eduSConscript('python/SConscript', exports = ['env'])
2671045SN/A
268955SN/A# This function adds the specified sources to the given build
269955SN/A# environment, and returns a list of all the corresponding SCons
270955SN/A# Object nodes (including an extra one for date.cc).  We explicitly
271955SN/A# add the Object nodes so we can set up special dependencies for
2721108SN/A# date.cc.
273955SN/Adef make_objs(sources, env):
274955SN/A    objs = [env.Object(s) for s in sources]
275955SN/A    # make date.cc depend on all other objects so it always gets
276955SN/A    # recompiled whenever anything else does
277955SN/A    date_obj = env.Object('base/date.cc')
278955SN/A    env.Depends(date_obj, objs)
279955SN/A    objs.append(date_obj)
280955SN/A    return objs
281955SN/A
282955SN/A###################################################
283955SN/A#
284955SN/A# Define binaries.  Each different build type (debug, opt, etc.) gets
285955SN/A# a slightly different build environment.
286955SN/A#
287955SN/A###################################################
288955SN/A
2892655Sstever@eecs.umich.edu# List of constructed environments to pass back to SConstruct
2902655Sstever@eecs.umich.eduenvList = []
2912655Sstever@eecs.umich.edu
2922655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
2932655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
2942655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
2952655Sstever@eecs.umich.edu# build environment vars.
2962655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
2972655Sstever@eecs.umich.edu    newEnv = env.Copy(OBJSUFFIX=objsfx)
2982655Sstever@eecs.umich.edu    newEnv.Label = label
2992655Sstever@eecs.umich.edu    newEnv.Append(**kwargs)
3002655Sstever@eecs.umich.edu    exe = 'm5.' + label  # final executable
3012655Sstever@eecs.umich.edu    bin = exe + '.bin'   # executable w/o appended Python zip archive
3022655Sstever@eecs.umich.edu    newEnv.Program(bin, make_objs(sources, newEnv))
3032655Sstever@eecs.umich.edu    if strip:
3042655Sstever@eecs.umich.edu        stripped_bin = bin + '.stripped'
3052655Sstever@eecs.umich.edu        newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
3062655Sstever@eecs.umich.edu        bin = stripped_bin
3072655Sstever@eecs.umich.edu    targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
3082655Sstever@eecs.umich.edu    newEnv.M5Binary = targets[0]
3092655Sstever@eecs.umich.edu    envList.append(newEnv)
3102655Sstever@eecs.umich.edu
311955SN/A# Debug binary
3123515Ssaidi@eecs.umich.edu# Solaris seems to have some issue with DWARF2 debugging information, it's ok
3133515Ssaidi@eecs.umich.edu# with stabs though
3143515Ssaidi@eecs.umich.eduif sys.platform == 'sunos5':
3153515Ssaidi@eecs.umich.edu   debug_flag = '-gstabs+'
3163515Ssaidi@eecs.umich.eduelse:
3173515Ssaidi@eecs.umich.edu   debug_flag = '-ggdb3'
3183515Ssaidi@eecs.umich.edu
3192655Sstever@eecs.umich.edumakeEnv('debug', '.do',
3203515Ssaidi@eecs.umich.edu        CCFLAGS = Split('%s -O0' % debug_flag),
3213619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
322955SN/A
323955SN/A# Optimized binary
3242655Sstever@eecs.umich.edumakeEnv('opt', '.o',
3253619Sbinkertn@umich.edu        CCFLAGS = Split('-g -O3'),
3263619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
327955SN/A
328955SN/A# "Fast" binary
3292655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
3302655Sstever@eecs.umich.edu        CCFLAGS = Split('-O3'),
3313619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
332955SN/A
333955SN/A# Profiled binary
3342655Sstever@eecs.umich.edumakeEnv('prof', '.po',
3352655Sstever@eecs.umich.edu        CCFLAGS = Split('-O3 -g -pg'),
3363683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
3372655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
3381869SN/A
3391869SN/AReturn('envList')
340