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('''
74 base/compression/lzss_compression.cc
75 base/loader/aout_object.cc
76 base/loader/ecoff_object.cc
77 base/loader/elf_object.cc
78 base/loader/raw_object.cc
79 base/loader/object_file.cc
107 mem/cache/base_cache.cc
109 mem/cache/coherence/coherence_protocol.cc
110 mem/cache/coherence/uni_coherence.cc
111 mem/cache/miss/blocking_buffer.cc
112 mem/cache/miss/miss_buffer.cc
113 mem/cache/miss/miss_queue.cc
114 mem/cache/miss/mshr.cc
115 mem/cache/miss/mshr_queue.cc
116 mem/cache/prefetch/base_prefetcher.cc
117 mem/cache/prefetch/ghb_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
130 mem/cache/cache_builder.cc
133 python/swig/debug_wrap.cc
134 python/swig/main_wrap.cc
135 python/swig/event_wrap.cc
136 python/swig/random_wrap.cc
137 python/swig/trace_wrap.cc
138 python/swig/pyevent.cc
157 trace_reader_sources = Split('''
158 cpu/trace/reader/mem_trace_reader.cc
159 cpu/trace/reader/ibm_reader.cc
160 cpu/trace/reader/itx_reader.cc
161 cpu/trace/reader/m5_reader.cc
163 cpu/trace/trace_cpu.cc
169 mysql_sources = Split('''
174 # Full-system sources
175 full_system_sources = Split('''
192 if env['TARGET_ISA'] == 'alpha':
193 full_system_sources += Split('''
194 kern/tru64/dump_mbuf.cc
196 kern/tru64/tru64_events.cc
197 kern/tru64/tru64_syscalls.cc
200 # Syscall emulation (non-full-system) sources
201 syscall_emulation_sources = Split('''
202 mem/translating_port.cc
208 #if env['TARGET_ISA'] == 'alpha':
209 # syscall_emulation_sources += Split('''
210 # kern/tru64/tru64.cc
213 memtest_sources = Split('''
214 cpu/memtest/memtest.cc
217 # Include file paths are rooted in this directory. SCons will
218 # automatically expand '.' to refer to both the source directory and
219 # the corresponding build directory to pick up generated include
221 env.Append(CPPPATH=Dir('.'))
223 # Add a flag defining what THE_ISA should be for all compilation
224 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
226 arch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
228 cpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
230 if env['FULL_SYSTEM']:
231 dev_sources = SConscript(os.path.join('dev', 'SConscript'),
233 full_system_sources += dev_sources
235 kern_sources = SConscript(os.path.join('kern', 'SConscript'),
237 full_system_sources += kern_sources
239 # Set up complete list of sources based on configuration.
240 sources = base_sources + arch_sources + cpu_sources
242 # encumbered should be last because we're adding to some of the other groups
243 if isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
244 sources += SConscript('encumbered/SConscript', exports = 'env')
247 if env['FULL_SYSTEM']:
248 sources += full_system_sources
250 sources += syscall_emulation_sources
253 sources += mysql_sources
255 for opt in env.ExportOptions:
258 ###################################################
260 # Special build rules.
262 ###################################################
264 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
265 # $TARGET.base will expand to "<build-dir>/base/traceflags".
266 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
267 'base/traceflags.py',
268 'python $SOURCE $TARGET.base')
270 SConscript('python/SConscript', exports = ['env'])
272 # This function adds the specified sources to the given build
273 # environment, and returns a list of all the corresponding SCons
274 # Object nodes (including an extra one for date.cc). We explicitly
275 # add the Object nodes so we can set up special dependencies for
277 def make_objs(sources, env):
278 objs = [env.Object(s) for s in sources]
279 # make date.cc depend on all other objects so it always gets
280 # recompiled whenever anything else does
281 date_obj = env.Object('base/date.cc')
282 env.Depends(date_obj, objs)
283 objs.append(date_obj)
286 ###################################################
288 # Define binaries. Each different build type (debug, opt, etc.) gets
289 # a slightly different build environment.
291 ###################################################
293 # List of constructed environments to pass back to SConstruct
296 # Function to create a new build environment as clone of current
297 # environment 'env' with modified object suffix and optional stripped
298 # binary. Additional keyword arguments are appended to corresponding
299 # build environment vars.
300 def makeEnv(label, objsfx, strip = False, **kwargs):
301 newEnv = env.Copy(OBJSUFFIX=objsfx)
303 newEnv.Append(**kwargs)
304 exe = 'm5.' + label # final executable
305 bin = exe + '.bin' # executable w/o appended Python zip archive
306 newEnv.Program(bin, make_objs(sources, newEnv))
308 stripped_bin = bin + '.stripped'
309 if sys.platform == 'sunos5':
310 newEnv.Command(stripped_bin, bin, 'cp $SOURCE $TARGET; strip $TARGET')
312 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
314 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
315 newEnv.M5Binary = targets[0]
316 envList.append(newEnv)
321 if sys.platform == 'sunos5':
322 ccflags['debug'] = '-gstabs+'
324 ccflags['debug'] = '-ggdb3'
325 ccflags['opt'] = '-g -O3'
326 ccflags['fast'] = '-O3'
327 ccflags['prof'] = '-O3 -g -pg'
329 ccflags['debug'] = '-g0'
330 ccflags['opt'] = '-g -O'
331 ccflags['fast'] = '-fast'
332 ccflags['prof'] = '-fast -g -pg'
334 ccflags['debug'] = '-g -O0'
335 ccflags['opt'] = '-g -O'
336 ccflags['fast'] = '-fast'
337 ccflags['prof'] = '-fast -g -pg'
339 print 'Unknown compiler, please fix compiler options'
342 makeEnv('debug', '.do',
343 CCFLAGS = Split(ccflags['debug']),
344 CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
348 CCFLAGS = Split(ccflags['opt']),
349 CPPDEFINES = ['TRACING_ON=1'])
352 makeEnv('fast', '.fo', strip = True,
353 CCFLAGS = Split(ccflags['fast']),
354 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
357 makeEnv('prof', '.po',
358 CCFLAGS = Split(ccflags['prof']),
359 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],