3 # Copyright (c) 2004-2005 The Regents of The University of Michigan
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.
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.
29 # Authors: Steve Reinhardt
33 from os.path import isfile, join as joinpath
35 # This file defines how to build a particular configuration of M5
36 # based on variable settings in the 'env' build environment.
38 # Import build environment variable from SConstruct.
41 ###################################################
43 # Define needed sources.
45 ###################################################
47 # Base sources used by all configurations.
49 base_sources = Split('''
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
106 mem/cache/base_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/stride_prefetcher.cc
118 mem/cache/prefetch/tagged_prefetcher.cc
119 mem/cache/tags/base_tags.cc
120 mem/cache/tags/fa_lru.cc
121 mem/cache/tags/iic.cc
122 mem/cache/tags/lru.cc
123 mem/cache/tags/repl/gen.cc
124 mem/cache/tags/repl/repl.cc
125 mem/cache/tags/split.cc
126 mem/cache/tags/split_lifo.cc
127 mem/cache/tags/split_lru.cc
129 mem/cache/cache_builder.cc
132 python/swig/debug_wrap.cc
133 python/swig/main_wrap.cc
152 trace_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
158 cpu/trace/trace_cpu.cc
164 mysql_sources = Split('''
169 # Full-system sources
170 full_system_sources = Split('''
188 if env['TARGET_ISA'] == 'alpha':
189 full_system_sources += Split('''
190 kern/tru64/dump_mbuf.cc
192 kern/tru64/tru64_events.cc
193 kern/tru64/tru64_syscalls.cc
196 # Syscall emulation (non-full-system) sources
197 syscall_emulation_sources = Split('''
198 mem/translating_port.cc
204 #if env['TARGET_ISA'] == 'alpha':
205 # syscall_emulation_sources += Split('''
206 # kern/tru64/tru64.cc
209 memtest_sources = Split('''
210 cpu/memtest/memtest.cc
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
217 env.Append(CPPPATH=Dir('.'))
219 # Add a flag defining what THE_ISA should be for all compilation
220 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
222 arch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
224 cpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
226 if env['FULL_SYSTEM']:
227 dev_sources = SConscript(os.path.join('dev', 'SConscript'),
229 full_system_sources += dev_sources
231 kern_sources = SConscript(os.path.join('kern', 'SConscript'),
233 full_system_sources += kern_sources
235 # Set up complete list of sources based on configuration.
236 sources = base_sources + arch_sources + cpu_sources
238 # encumbered should be last because we're adding to some of the other groups
239 if isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
240 sources += SConscript('encumbered/SConscript', exports = 'env')
243 if env['FULL_SYSTEM']:
244 sources += full_system_sources
246 sources += syscall_emulation_sources
249 sources += mysql_sources
251 for opt in env.ExportOptions:
254 ###################################################
256 # Special build rules.
258 ###################################################
260 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
261 # $TARGET.base will expand to "<build-dir>/base/traceflags".
262 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
263 'base/traceflags.py',
264 'python $SOURCE $TARGET.base')
266 SConscript('python/SConscript', exports = ['env'])
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
273 def 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)
282 ###################################################
284 # Define binaries. Each different build type (debug, opt, etc.) gets
285 # a slightly different build environment.
287 ###################################################
289 # List of constructed environments to pass back to SConstruct
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.
296 def makeEnv(label, objsfx, strip = False, **kwargs):
297 newEnv = env.Copy(OBJSUFFIX=objsfx)
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))
304 stripped_bin = bin + '.stripped'
305 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
307 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
308 newEnv.M5Binary = targets[0]
309 envList.append(newEnv)
312 # Solaris seems to have some issue with DWARF2 debugging information, it's ok
314 if sys.platform == 'sunos5':
315 debug_flag = '-gstabs+'
317 debug_flag = '-ggdb3'
319 makeEnv('debug', '.do',
320 CCFLAGS = Split('%s -O0' % debug_flag),
321 CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
325 CCFLAGS = Split('-g -O3'),
326 CPPDEFINES = ['TRACING_ON=1'])
329 makeEnv('fast', '.fo', strip = True,
330 CCFLAGS = Split('-O3'),
331 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
334 makeEnv('prof', '.po',
335 CCFLAGS = Split('-O3 -g -pg'),
336 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],