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.
31 from os.path import isdir
33 # This file defines how to build a particular configuration of M5
34 # based on variable settings in the 'env' build environment.
36 # Import build environment variable from SConstruct.
39 ###################################################
41 # Define needed sources.
43 ###################################################
45 # Base sources used by all configurations.
46 base_sources = Split('''
48 arch/alpha/alpha_o3_exec.cc
49 arch/alpha/fast_cpu_exec.cc
50 arch/alpha/simple_cpu_exec.cc
51 arch/alpha/full_cpu_exec.cc
53 arch/alpha/isa_traits.cc
79 base/compression/lzss_compression.cc
80 base/loader/aout_object.cc
81 base/loader/ecoff_object.cc
82 base/loader/elf_object.cc
83 base/loader/object_file.cc
96 cpu/o3/2bit_local_pred.cc
97 cpu/o3/alpha_dyn_inst.cc
99 cpu/o3/alpha_cpu_builder.cc
110 cpu/o3/mem_dep_unit.cc
115 cpu/o3/sat_counter.cc
117 cpu/o3/tournament_pred.cc
119 cpu/sampler/sampler.cc
121 cpu/trace/reader/mem_trace_reader.cc
122 cpu/trace/reader/ibm_reader.cc
123 cpu/trace/reader/itx_reader.cc
124 cpu/trace/reader/m5_reader.cc
126 cpu/trace/trace_cpu.cc
128 encumbered/cpu/full/bpred.cc
129 encumbered/cpu/full/commit.cc
130 encumbered/cpu/full/cpu.cc
131 encumbered/cpu/full/create_vector.cc
132 encumbered/cpu/full/cv_spec_state.cc
133 encumbered/cpu/full/dd_queue.cc
134 encumbered/cpu/full/dep_link.cc
135 encumbered/cpu/full/dispatch.cc
136 encumbered/cpu/full/dyn_inst.cc
137 encumbered/cpu/full/execute.cc
138 encumbered/cpu/full/fetch.cc
139 encumbered/cpu/full/floss_reasons.cc
140 encumbered/cpu/full/fu_pool.cc
141 encumbered/cpu/full/inst_fifo.cc
142 encumbered/cpu/full/instpipe.cc
143 encumbered/cpu/full/issue.cc
144 encumbered/cpu/full/ls_queue.cc
145 encumbered/cpu/full/machine_queue.cc
146 encumbered/cpu/full/pipetrace.cc
147 encumbered/cpu/full/readyq.cc
148 encumbered/cpu/full/reg_info.cc
149 encumbered/cpu/full/rob_station.cc
150 encumbered/cpu/full/spec_memory.cc
151 encumbered/cpu/full/spec_state.cc
152 encumbered/cpu/full/storebuffer.cc
153 encumbered/cpu/full/writeback.cc
154 encumbered/cpu/full/iq/iq_station.cc
155 encumbered/cpu/full/iq/iqueue.cc
156 encumbered/cpu/full/iq/segmented/chain_info.cc
157 encumbered/cpu/full/iq/segmented/chain_wire.cc
158 encumbered/cpu/full/iq/segmented/iq_seg.cc
159 encumbered/cpu/full/iq/segmented/iq_segmented.cc
160 encumbered/cpu/full/iq/segmented/seg_chain.cc
161 encumbered/cpu/full/iq/seznec/iq_seznec.cc
162 encumbered/cpu/full/iq/standard/iq_standard.cc
163 encumbered/mem/functional/main.cc
171 mem/memory_interface.cc
172 mem/bus/base_interface.cc
174 mem/bus/bus_bridge.cc
175 mem/bus/bus_bridge_master.cc
176 mem/bus/bus_bridge_slave.cc
177 mem/bus/bus_interface.cc
178 mem/bus/dma_bus_interface.cc
179 mem/bus/dma_interface.cc
180 mem/bus/master_interface.cc
181 mem/bus/slave_interface.cc
182 mem/cache/base_cache.cc
184 mem/cache/cache_builder.cc
185 mem/cache/coherence/coherence_protocol.cc
186 mem/cache/coherence/uni_coherence.cc
187 mem/cache/miss/blocking_buffer.cc
188 mem/cache/miss/miss_queue.cc
189 mem/cache/miss/mshr.cc
190 mem/cache/miss/mshr_queue.cc
191 mem/cache/prefetch/base_prefetcher.cc
192 mem/cache/prefetch/prefetcher.cc
193 mem/cache/prefetch/tagged_prefetcher.cc
194 mem/cache/tags/base_tags.cc
195 mem/cache/tags/cache_tags.cc
196 mem/cache/tags/fa_lru.cc
197 mem/cache/tags/iic.cc
198 mem/cache/tags/lru.cc
199 mem/cache/tags/repl/gen.cc
200 mem/cache/tags/repl/repl.cc
201 mem/cache/tags/split.cc
202 mem/cache/tags/split_lru.cc
203 mem/cache/tags/split_lifo.cc
204 mem/functional/functional.cc
205 mem/timing/base_memory.cc
206 mem/timing/memory_builder.cc
207 mem/timing/simple_mem_bank.cc
208 mem/trace/itx_writer.cc
209 mem/trace/mem_trace_writer.cc
210 mem/trace/m5_writer.cc
213 python/embedded_py.cc
234 mysql_sources = Split('''
239 # Full-system sources
240 full_system_sources = Split('''
241 arch/alpha/alpha_memory.cc
242 arch/alpha/arguments.cc
245 arch/alpha/pseudo_inst.cc
246 arch/alpha/stacktrace.cc
247 arch/alpha/vtophys.cc
285 kern/kernel_binning.cc
287 kern/system_events.cc
288 kern/freebsd/freebsd_system.cc
289 kern/linux/linux_syscalls.cc
290 kern/linux/linux_system.cc
292 kern/tru64/dump_mbuf.cc
294 kern/tru64/tru64_events.cc
295 kern/tru64/tru64_syscalls.cc
296 kern/tru64/tru64_system.cc
298 mem/functional/memory_control.cc
299 mem/functional/physical.cc
304 # turbolaser encumbered sources
305 turbolaser_sources = Split('''
306 encumbered/dev/dma.cc
307 encumbered/dev/etherdev.cc
308 encumbered/dev/scsi.cc
309 encumbered/dev/scsi_ctrl.cc
310 encumbered/dev/scsi_disk.cc
311 encumbered/dev/scsi_none.cc
312 encumbered/dev/tlaser_clock.cc
313 encumbered/dev/tlaser_ipi.cc
314 encumbered/dev/tlaser_mbox.cc
315 encumbered/dev/tlaser_mc146818.cc
316 encumbered/dev/tlaser_node.cc
317 encumbered/dev/tlaser_pcia.cc
318 encumbered/dev/tlaser_pcidev.cc
319 encumbered/dev/tlaser_serial.cc
320 encumbered/dev/turbolaser.cc
321 encumbered/dev/uart8530.cc
324 # Syscall emulation (non-full-system) sources
325 syscall_emulation_sources = Split('''
326 arch/alpha/alpha_common_syscall_emul.cc
327 arch/alpha/alpha_linux_process.cc
328 arch/alpha/alpha_tru64_process.cc
329 cpu/memtest/memtest.cc
330 encumbered/eio/eio.cc
331 encumbered/eio/exolex.cc
332 encumbered/eio/libexo.cc
337 targetarch_files = Split('''
338 alpha_common_syscall_emul.hh
339 alpha_linux_process.hh
341 alpha_tru64_process.hh
348 isa_fullsys_traits.hh
357 for f in targetarch_files:
358 env.Command('targetarch/' + f, 'arch/alpha/' + f,
359 '''echo '#include "arch/alpha/%s"' > $TARGET''' % f)
362 # Set up complete list of sources based on configuration.
363 sources = base_sources
365 if env['FULL_SYSTEM']:
366 sources += full_system_sources
367 if env['ALPHA_TLASER']:
368 sources += turbolaser_sources
370 sources += syscall_emulation_sources
373 sources += mysql_sources
375 for opt in env.ExportOptions:
378 ###################################################
380 # Special build rules.
382 ###################################################
384 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
385 # $TARGET.base will expand to "<build-dir>/base/traceflags".
386 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
387 'base/traceflags.py',
388 'python $SOURCE $TARGET.base')
390 # several files are generated from arch/$TARGET_ISA/isa_desc.
391 env.Command(Split('''arch/alpha/decoder.cc
392 arch/alpha/decoder.hh
393 arch/alpha/alpha_o3_exec.cc
394 arch/alpha/fast_cpu_exec.cc
395 arch/alpha/simple_cpu_exec.cc
396 arch/alpha/full_cpu_exec.cc'''),
397 Split('''arch/alpha/isa_desc
398 arch/isa_parser.py'''),
399 '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
402 # libelf build is described in its own SConscript file.
403 # SConscript-local is the per-config build, which just copies some
404 # header files into a place where they can be found.
405 SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
406 SConscript('python/SConscript', exports = ['env'], duplicate=0)
408 # This function adds the specified sources to the given build
409 # environment, and returns a list of all the corresponding SCons
410 # Object nodes (including an extra one for date.cc). We explicitly
411 # add the Object nodes so we can set up special dependencies for
413 def make_objs(sources, env):
414 objs = [env.Object(s) for s in sources]
415 # make date.cc depend on all other objects so it always gets
416 # recompiled whenever anything else does
417 date_obj = env.Object('base/date.cc')
418 env.Depends(date_obj, objs)
419 objs.append(date_obj)
422 ###################################################
424 # Define binaries. Each different build type (debug, opt, etc.) gets
425 # a slightly different build environment.
427 ###################################################
429 # Include file paths are rooted in this directory. SCons will
430 # automatically expand '.' to refer to both the source directory and
431 # the corresponding build directory to pick up generated include
433 env.Append(CPPPATH='.')
436 debugEnv = env.Copy(OBJSUFFIX='.do')
437 debugEnv.Label = 'debug'
438 debugEnv.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
439 debugEnv.Append(CPPDEFINES='DEBUG')
440 tlist = debugEnv.Program(target = 'm5.debug',
441 source = make_objs(sources, debugEnv))
442 debugEnv.M5Binary = tlist[0]
447 optEnv.Append(CCFLAGS=Split('-g -O5'))
448 tlist = optEnv.Program(target = 'm5.opt',
449 source = make_objs(sources, optEnv))
450 optEnv.M5Binary = tlist[0]
453 fastEnv = env.Copy(OBJSUFFIX='.fo')
454 fastEnv.Label = 'fast'
455 fastEnv.Append(CCFLAGS=Split('-O5'))
456 fastEnv.Append(CPPDEFINES='NDEBUG')
457 fastEnv.Program(target = 'm5.fast.unstripped',
458 source = make_objs(sources, fastEnv))
459 tlist = fastEnv.Command(target = 'm5.fast',
460 source = 'm5.fast.unstripped',
461 action = 'strip $SOURCE -o $TARGET')
462 fastEnv.M5Binary = tlist[0]
465 profEnv = env.Copy(OBJSUFFIX='.po')
466 profEnv.Label = 'prof'
467 profEnv.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
468 tlist = profEnv.Program(target = 'm5.prof',
469 source = make_objs(sources, profEnv))
470 profEnv.M5Binary = tlist[0]
472 envList = [debugEnv, optEnv, fastEnv, profEnv]