SConscript revision 4007
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
653960Sgblack@eecs.umich.edu	base/remote_gdb.cc
66955SN/A	base/sat_counter.cc
67955SN/A	base/socket.cc
68955SN/A	base/statistics.cc
69955SN/A	base/str.cc
70955SN/A	base/time.cc
71955SN/A	base/trace.cc
72955SN/A	base/traceflags.cc
73955SN/A	base/userinfo.cc
74955SN/A	base/compression/lzss_compression.cc
75955SN/A	base/loader/aout_object.cc
76955SN/A	base/loader/ecoff_object.cc
77955SN/A	base/loader/elf_object.cc
783584Ssaidi@eecs.umich.edu	base/loader/raw_object.cc
79955SN/A	base/loader/object_file.cc
80955SN/A	base/loader/symtab.cc
81955SN/A	base/stats/events.cc
82955SN/A	base/stats/statdb.cc
83955SN/A	base/stats/visit.cc
84955SN/A	base/stats/text.cc
85955SN/A
862325SN/A        cpu/activity.cc
871717SN/A	cpu/base.cc
882652Ssaidi@eecs.umich.edu	cpu/cpuevent.cc
89955SN/A	cpu/exetrace.cc
902736Sktlim@umich.edu        cpu/func_unit.cc
912410SN/A        cpu/op_class.cc
92955SN/A	cpu/pc_event.cc
932290SN/A        cpu/quiesce_event.cc
94955SN/A	cpu/static_inst.cc
952683Sktlim@umich.edu        cpu/simple_thread.cc
962683Sktlim@umich.edu        cpu/thread_state.cc
972669Sktlim@umich.edu
982568SN/A        mem/bridge.cc
992568SN/A        mem/bus.cc
1003012Ssaidi@eecs.umich.edu        mem/dram.cc
1012462SN/A        mem/mem_object.cc
1022568SN/A        mem/packet.cc
1032395SN/A        mem/physical.cc
1042405SN/A        mem/port.cc
1052914Ssaidi@eecs.umich.edu        mem/tport.cc
106955SN/A
1072811Srdreslin@umich.edu        mem/cache/base_cache.cc
1082811Srdreslin@umich.edu        mem/cache/cache.cc
1092811Srdreslin@umich.edu        mem/cache/coherence/coherence_protocol.cc
1102811Srdreslin@umich.edu        mem/cache/coherence/uni_coherence.cc
1112811Srdreslin@umich.edu        mem/cache/miss/blocking_buffer.cc
1123719Sstever@eecs.umich.edu        mem/cache/miss/miss_buffer.cc
1132811Srdreslin@umich.edu        mem/cache/miss/miss_queue.cc
1142811Srdreslin@umich.edu        mem/cache/miss/mshr.cc
1152811Srdreslin@umich.edu        mem/cache/miss/mshr_queue.cc
1162811Srdreslin@umich.edu        mem/cache/prefetch/base_prefetcher.cc
1172811Srdreslin@umich.edu        mem/cache/prefetch/ghb_prefetcher.cc
1182811Srdreslin@umich.edu        mem/cache/prefetch/stride_prefetcher.cc
1192811Srdreslin@umich.edu        mem/cache/prefetch/tagged_prefetcher.cc
1202811Srdreslin@umich.edu        mem/cache/tags/base_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
1323868Sbinkertn@umich.edu        python/swig/init.cc
1333645Sbinkertn@umich.edu        python/swig/debug_wrap.cc
1343624Sbinkertn@umich.edu        python/swig/main_wrap.cc
1353871Sbinkertn@umich.edu        python/swig/event_wrap.cc
1363871Sbinkertn@umich.edu        python/swig/pyevent.cc
1373624Sbinkertn@umich.edu
138955SN/A	sim/builder.cc
139955SN/A	sim/debug.cc
140955SN/A	sim/eventq.cc
1412090SN/A	sim/faults.cc
142955SN/A	sim/main.cc
143955SN/A	sim/param.cc
1441696SN/A	sim/root.cc
145955SN/A	sim/serialize.cc
146955SN/A	sim/sim_events.cc
147955SN/A	sim/sim_object.cc
1481127SN/A	sim/startup.cc
149955SN/A	sim/stat_context.cc
150955SN/A	sim/stat_control.cc
1512379SN/A	sim/system.cc
152955SN/A	sim/trace_context.cc
153955SN/A        ''')
154955SN/A
1552422SN/Atrace_reader_sources = Split('''
1562422SN/A        cpu/trace/reader/mem_trace_reader.cc
1572422SN/A        cpu/trace/reader/ibm_reader.cc
1582422SN/A        cpu/trace/reader/itx_reader.cc
1592422SN/A        cpu/trace/reader/m5_reader.cc
1602422SN/A        cpu/trace/opt_cpu.cc
1612422SN/A        cpu/trace/trace_cpu.cc
1622397SN/A        ''')
1632397SN/A
1642422SN/A
1652422SN/A
166955SN/A# MySql sources
167955SN/Amysql_sources = Split('''
168955SN/A	base/mysql.cc
169955SN/A	base/stats/mysql.cc
170955SN/A        ''')
171955SN/A
172955SN/A# Full-system sources
173955SN/Afull_system_sources = Split('''
1741078SN/A	base/crc.cc
175955SN/A	base/inet.cc
176955SN/A
177955SN/A	cpu/intr_control.cc
1781917SN/A        cpu/profile.cc
179955SN/A
180955SN/A	dev/uart.cc
1811730SN/A	dev/uart8250.cc
182955SN/A
1832521SN/A        mem/vport.cc
1842521SN/A
1852507SN/A	sim/pseudo_inst.cc
1862507SN/A        ''')
1872989Ssaidi@eecs.umich.edu	#dev/sinic.cc
1883408Ssaidi@eecs.umich.edu        #dev/i8254xGBe.cc
1892507SN/A
1902507SN/Aif env['TARGET_ISA'] == 'alpha':
1912507SN/A    full_system_sources += Split('''
192955SN/A	kern/tru64/dump_mbuf.cc
193955SN/A	kern/tru64/printf.cc
194955SN/A	kern/tru64/tru64_events.cc
195955SN/A	kern/tru64/tru64_syscalls.cc
196955SN/A        ''')
197955SN/A
198955SN/A# Syscall emulation (non-full-system) sources
199955SN/Asyscall_emulation_sources = Split('''
2002520SN/A        mem/translating_port.cc
2012517SN/A        mem/page_table.cc
2022253SN/A	sim/process.cc
2032253SN/A	sim/syscall_emul.cc
2042253SN/A        ''')
2052253SN/A
2062553SN/A#if env['TARGET_ISA'] == 'alpha':
2072553SN/A#    syscall_emulation_sources += Split('''
2082553SN/A#        kern/tru64/tru64.cc
2092553SN/A#        ''')
2102507SN/A
2112400SN/Amemtest_sources = Split('''
2122400SN/A	cpu/memtest/memtest.cc
213955SN/A        ''')
214955SN/A
2152667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2162667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2172667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2182667Sstever@eecs.umich.edu# files.
2192667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2202667Sstever@eecs.umich.edu
2212037SN/A# Add a flag defining what THE_ISA should be for all compilation
2222037SN/Aenv.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
2232037SN/A
2243534Sgblack@eecs.umich.eduarch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
2252139SN/A
2263534Sgblack@eecs.umich.educpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
2273534Sgblack@eecs.umich.edu
2283542Sgblack@eecs.umich.eduif env['FULL_SYSTEM']:
2293583Sbinkertn@umich.edu    dev_sources = SConscript(os.path.join('dev', 'SConscript'),
2303583Sbinkertn@umich.edu                             exports = 'env')
2313542Sgblack@eecs.umich.edu    full_system_sources += dev_sources
2323499Ssaidi@eecs.umich.edu
2333583Sbinkertn@umich.edu    kern_sources = SConscript(os.path.join('kern', 'SConscript'),
2343583Sbinkertn@umich.edu                              exports = 'env')
2353547Sgblack@eecs.umich.edu    full_system_sources += kern_sources
2362155SN/A
237955SN/A# Set up complete list of sources based on configuration.
2382155SN/Asources = base_sources + arch_sources + cpu_sources
239955SN/A
2403583Sbinkertn@umich.edu# encumbered should be last because we're adding to some of the other groups
2413583Sbinkertn@umich.eduif isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
2423583Sbinkertn@umich.edu    sources += SConscript('encumbered/SConscript', exports = 'env')
2433583Sbinkertn@umich.edu
2443583Sbinkertn@umich.edu
245955SN/Aif env['FULL_SYSTEM']:
246955SN/A    sources += full_system_sources
247955SN/Aelse:
248955SN/A    sources += syscall_emulation_sources
249955SN/A
2501858SN/Aif env['USE_MYSQL']:
251955SN/A    sources += mysql_sources
2521858SN/A
2531858SN/Afor opt in env.ExportOptions:
2541858SN/A    env.ConfigFile(opt)
2551085SN/A
256955SN/A###################################################
257955SN/A#
258955SN/A# Special build rules.
259955SN/A#
260955SN/A###################################################
261955SN/A
262955SN/A# base/traceflags.{cc,hh} are generated from base/traceflags.py.
263955SN/A# $TARGET.base will expand to "<build-dir>/base/traceflags".
264955SN/Aenv.Command(Split('base/traceflags.hh base/traceflags.cc'),
265955SN/A            'base/traceflags.py',
266955SN/A            'python $SOURCE $TARGET.base')
267955SN/A
2682667Sstever@eecs.umich.eduSConscript('python/SConscript', exports = ['env'])
2691045SN/A
270955SN/A# This function adds the specified sources to the given build
271955SN/A# environment, and returns a list of all the corresponding SCons
272955SN/A# Object nodes (including an extra one for date.cc).  We explicitly
273955SN/A# add the Object nodes so we can set up special dependencies for
2741108SN/A# date.cc.
275955SN/Adef make_objs(sources, env):
276955SN/A    objs = [env.Object(s) for s in sources]
277955SN/A    # make date.cc depend on all other objects so it always gets
278955SN/A    # recompiled whenever anything else does
279955SN/A    date_obj = env.Object('base/date.cc')
280955SN/A    env.Depends(date_obj, objs)
281955SN/A    objs.append(date_obj)
282955SN/A    return objs
283955SN/A
284955SN/A###################################################
285955SN/A#
286955SN/A# Define binaries.  Each different build type (debug, opt, etc.) gets
287955SN/A# a slightly different build environment.
288955SN/A#
289955SN/A###################################################
290955SN/A
2912655Sstever@eecs.umich.edu# List of constructed environments to pass back to SConstruct
2922655Sstever@eecs.umich.eduenvList = []
2932655Sstever@eecs.umich.edu
2942655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
2952655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
2962655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
2972655Sstever@eecs.umich.edu# build environment vars.
2982655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
2992655Sstever@eecs.umich.edu    newEnv = env.Copy(OBJSUFFIX=objsfx)
3002655Sstever@eecs.umich.edu    newEnv.Label = label
3012655Sstever@eecs.umich.edu    newEnv.Append(**kwargs)
3022655Sstever@eecs.umich.edu    exe = 'm5.' + label  # final executable
3032655Sstever@eecs.umich.edu    bin = exe + '.bin'   # executable w/o appended Python zip archive
3042655Sstever@eecs.umich.edu    newEnv.Program(bin, make_objs(sources, newEnv))
3052655Sstever@eecs.umich.edu    if strip:
3062655Sstever@eecs.umich.edu        stripped_bin = bin + '.stripped'
3074007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
3084007Ssaidi@eecs.umich.edu            newEnv.Command(stripped_bin, bin, 'cp $SOURCE $TARGET; strip $TARGET')
3094007Ssaidi@eecs.umich.edu        else:
3104007Ssaidi@eecs.umich.edu            newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
3112655Sstever@eecs.umich.edu        bin = stripped_bin
3122655Sstever@eecs.umich.edu    targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
3132655Sstever@eecs.umich.edu    newEnv.M5Binary = targets[0]
3142655Sstever@eecs.umich.edu    envList.append(newEnv)
3152655Sstever@eecs.umich.edu
316955SN/A# Debug binary
3173918Ssaidi@eecs.umich.educcflags = {}
3183918Ssaidi@eecs.umich.eduif env['GCC']:
3193918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
3203918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-gstabs+'
3213918Ssaidi@eecs.umich.edu    else:
3223918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-ggdb3'
3233918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O3'
3243918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-O3'
3253918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-O3 -g -pg'
3263918Ssaidi@eecs.umich.eduelif env['SUNCC']:
3273918Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g0'
3283918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
3293918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
3303918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
3313940Ssaidi@eecs.umich.eduelif env['ICC']:
3323940Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g -O0'
3333940Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
3343942Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
3353940Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
3363515Ssaidi@eecs.umich.eduelse:
3373918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
3383918Ssaidi@eecs.umich.edu    Exit(1)    
3393515Ssaidi@eecs.umich.edu
3402655Sstever@eecs.umich.edumakeEnv('debug', '.do',
3413918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['debug']),
3423619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
343955SN/A
344955SN/A# Optimized binary
3452655Sstever@eecs.umich.edumakeEnv('opt', '.o',
3463918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['opt']),
3473619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
348955SN/A
349955SN/A# "Fast" binary
3502655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
3513918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
3523619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
353955SN/A
354955SN/A# Profiled binary
3552655Sstever@eecs.umich.edumakeEnv('prof', '.po',
3563918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['prof']),
3573683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
3582655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
3591869SN/A
3601869SN/AReturn('envList')
361