SConscript revision 3860:73e3642713a3 
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# Authors: Steve Reinhardt
30
31import os
32import sys
33from os.path import isfile, join as joinpath
34
35# This file defines how to build a particular configuration of M5
36# based on variable settings in the 'env' build environment.
37
38# Import build environment variable from SConstruct.
39Import('env')
40
41###################################################
42#
43# Define needed sources.
44#
45###################################################
46
47# Base sources used by all configurations.
48
49base_sources = Split('''
50	base/annotate.cc
51	base/circlebuf.cc
52	base/cprintf.cc
53	base/fast_alloc.cc
54	base/fifo_buffer.cc
55	base/hostinfo.cc
56	base/hybrid_pred.cc
57	base/inifile.cc
58	base/intmath.cc
59	base/match.cc
60	base/misc.cc
61	base/output.cc
62	base/pollevent.cc
63	base/range.cc
64	base/random.cc
65	base/sat_counter.cc
66	base/socket.cc
67	base/statistics.cc
68	base/str.cc
69	base/time.cc
70	base/trace.cc
71	base/traceflags.cc
72	base/userinfo.cc
73	base/compression/lzss_compression.cc
74	base/loader/aout_object.cc
75	base/loader/ecoff_object.cc
76	base/loader/elf_object.cc
77	base/loader/raw_object.cc
78	base/loader/object_file.cc
79	base/loader/symtab.cc
80	base/stats/events.cc
81	base/stats/statdb.cc
82	base/stats/visit.cc
83	base/stats/text.cc
84
85        cpu/activity.cc
86	cpu/base.cc
87	cpu/cpuevent.cc
88	cpu/exetrace.cc
89        cpu/func_unit.cc
90        cpu/op_class.cc
91	cpu/pc_event.cc
92        cpu/quiesce_event.cc
93	cpu/static_inst.cc
94        cpu/simple_thread.cc
95        cpu/thread_state.cc
96
97        mem/bridge.cc
98        mem/bus.cc
99        mem/dram.cc
100        mem/mem_object.cc
101        mem/packet.cc
102        mem/physical.cc
103        mem/port.cc
104        mem/tport.cc
105
106        mem/cache/base_cache.cc
107        mem/cache/cache.cc
108        mem/cache/coherence/coherence_protocol.cc
109        mem/cache/coherence/uni_coherence.cc
110        mem/cache/miss/blocking_buffer.cc
111        mem/cache/miss/miss_buffer.cc
112        mem/cache/miss/miss_queue.cc
113        mem/cache/miss/mshr.cc
114        mem/cache/miss/mshr_queue.cc
115        mem/cache/prefetch/base_prefetcher.cc
116        mem/cache/prefetch/ghb_prefetcher.cc
117        mem/cache/prefetch/prefetcher.cc
118        mem/cache/prefetch/stride_prefetcher.cc
119        mem/cache/prefetch/tagged_prefetcher.cc
120        mem/cache/tags/base_tags.cc
121        mem/cache/tags/fa_lru.cc
122        mem/cache/tags/iic.cc
123        mem/cache/tags/lru.cc
124        mem/cache/tags/repl/gen.cc
125        mem/cache/tags/repl/repl.cc
126        mem/cache/tags/split.cc
127        mem/cache/tags/split_lifo.cc
128        mem/cache/tags/split_lru.cc
129
130        mem/cache/cache_builder.cc
131
132        python/swig/debug_wrap.cc
133        python/swig/main_wrap.cc
134
135	sim/builder.cc
136	sim/debug.cc
137	sim/eventq.cc
138	sim/faults.cc
139	sim/main.cc
140	sim/param.cc
141	sim/root.cc
142	sim/serialize.cc
143	sim/sim_events.cc
144	sim/sim_object.cc
145	sim/startup.cc
146	sim/stat_context.cc
147	sim/stat_control.cc
148	sim/system.cc
149	sim/trace_context.cc
150        ''')
151
152trace_reader_sources = Split('''
153        cpu/trace/reader/mem_trace_reader.cc
154        cpu/trace/reader/ibm_reader.cc
155        cpu/trace/reader/itx_reader.cc
156        cpu/trace/reader/m5_reader.cc
157        cpu/trace/opt_cpu.cc
158        cpu/trace/trace_cpu.cc
159        ''')
160
161
162
163# MySql sources
164mysql_sources = Split('''
165	base/mysql.cc
166	base/stats/mysql.cc
167        ''')
168
169# Full-system sources
170full_system_sources = Split('''
171	base/crc.cc
172	base/inet.cc
173	base/remote_gdb.cc
174
175	cpu/intr_control.cc
176        cpu/profile.cc
177
178	dev/uart.cc
179	dev/uart8250.cc
180
181        mem/vport.cc
182
183	sim/pseudo_inst.cc
184        ''')
185	#dev/sinic.cc
186        #dev/i8254xGBe.cc
187
188if env['TARGET_ISA'] == 'alpha':
189    full_system_sources += Split('''
190	kern/tru64/dump_mbuf.cc
191	kern/tru64/printf.cc
192	kern/tru64/tru64_events.cc
193	kern/tru64/tru64_syscalls.cc
194        ''')
195
196# Syscall emulation (non-full-system) sources
197syscall_emulation_sources = Split('''
198        mem/translating_port.cc
199        mem/page_table.cc
200	sim/process.cc
201	sim/syscall_emul.cc
202        ''')
203
204#if env['TARGET_ISA'] == 'alpha':
205#    syscall_emulation_sources += Split('''
206#        kern/tru64/tru64.cc
207#        ''')
208
209memtest_sources = Split('''
210	cpu/memtest/memtest.cc
211        ''')
212
213# Include file paths are rooted in this directory.  SCons will
214# automatically expand '.' to refer to both the source directory and
215# the corresponding build directory to pick up generated include
216# files.
217env.Append(CPPPATH=Dir('.'))
218
219# Add a flag defining what THE_ISA should be for all compilation
220env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
221
222arch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
223
224cpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
225
226if env['FULL_SYSTEM']:
227    dev_sources = SConscript(os.path.join('dev', 'SConscript'),
228                             exports = 'env')
229    full_system_sources += dev_sources
230
231    kern_sources = SConscript(os.path.join('kern', 'SConscript'),
232                              exports = 'env')
233    full_system_sources += kern_sources
234
235# Set up complete list of sources based on configuration.
236sources = base_sources + arch_sources + cpu_sources
237
238# encumbered should be last because we're adding to some of the other groups
239if isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
240    sources += SConscript('encumbered/SConscript', exports = 'env')
241
242
243if env['FULL_SYSTEM']:
244    sources += full_system_sources
245else:
246    sources += syscall_emulation_sources
247
248if env['USE_MYSQL']:
249    sources += mysql_sources
250
251for opt in env.ExportOptions:
252    env.ConfigFile(opt)
253
254###################################################
255#
256# Special build rules.
257#
258###################################################
259
260# base/traceflags.{cc,hh} are generated from base/traceflags.py.
261# $TARGET.base will expand to "<build-dir>/base/traceflags".
262env.Command(Split('base/traceflags.hh base/traceflags.cc'),
263            'base/traceflags.py',
264            'python $SOURCE $TARGET.base')
265
266SConscript('python/SConscript', exports = ['env'])
267
268# This function adds the specified sources to the given build
269# environment, and returns a list of all the corresponding SCons
270# Object nodes (including an extra one for date.cc).  We explicitly
271# add the Object nodes so we can set up special dependencies for
272# date.cc.
273def make_objs(sources, env):
274    objs = [env.Object(s) for s in sources]
275    # make date.cc depend on all other objects so it always gets
276    # recompiled whenever anything else does
277    date_obj = env.Object('base/date.cc')
278    env.Depends(date_obj, objs)
279    objs.append(date_obj)
280    return objs
281
282###################################################
283#
284# Define binaries.  Each different build type (debug, opt, etc.) gets
285# a slightly different build environment.
286#
287###################################################
288
289# List of constructed environments to pass back to SConstruct
290envList = []
291
292# Function to create a new build environment as clone of current
293# environment 'env' with modified object suffix and optional stripped
294# binary.  Additional keyword arguments are appended to corresponding
295# build environment vars.
296def makeEnv(label, objsfx, strip = False, **kwargs):
297    newEnv = env.Copy(OBJSUFFIX=objsfx)
298    newEnv.Label = label
299    newEnv.Append(**kwargs)
300    exe = 'm5.' + label  # final executable
301    bin = exe + '.bin'   # executable w/o appended Python zip archive
302    newEnv.Program(bin, make_objs(sources, newEnv))
303    if strip:
304        stripped_bin = bin + '.stripped'
305        newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
306        bin = stripped_bin
307    targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
308    newEnv.M5Binary = targets[0]
309    envList.append(newEnv)
310
311# Debug binary
312# Solaris seems to have some issue with DWARF2 debugging information, it's ok
313# with stabs though
314if sys.platform == 'sunos5':
315   debug_flag = '-gstabs+'
316else:
317   debug_flag = '-ggdb3'
318
319makeEnv('debug', '.do',
320        CCFLAGS = Split('%s -O0' % debug_flag),
321        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
322
323# Optimized binary
324makeEnv('opt', '.o',
325        CCFLAGS = Split('-g -O3'),
326        CPPDEFINES = ['TRACING_ON=1'])
327
328# "Fast" binary
329makeEnv('fast', '.fo', strip = True,
330        CCFLAGS = Split('-O3'),
331        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
332
333# Profiled binary
334makeEnv('prof', '.po',
335        CCFLAGS = Split('-O3 -g -pg'),
336        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
337        LINKFLAGS = '-pg')
338
339Return('envList')
340