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.
47 base_sources = Split('''
72 base/compression/lzss_compression.cc
73 base/loader/aout_object.cc
74 base/loader/ecoff_object.cc
75 base/loader/elf_object.cc
76 base/loader/object_file.cc
89 cpu/o3/2bit_local_pred.cc
90 cpu/o3/alpha_dyn_inst.cc
92 cpu/o3/alpha_cpu_builder.cc
103 cpu/o3/mem_dep_unit.cc
108 cpu/o3/sat_counter.cc
110 cpu/o3/tournament_pred.cc
112 cpu/sampler/sampler.cc
114 cpu/trace/reader/mem_trace_reader.cc
115 cpu/trace/reader/ibm_reader.cc
116 cpu/trace/reader/itx_reader.cc
117 cpu/trace/reader/m5_reader.cc
119 cpu/trace/trace_cpu.cc
121 encumbered/cpu/full/bpred.cc
122 encumbered/cpu/full/commit.cc
123 encumbered/cpu/full/cpu.cc
124 encumbered/cpu/full/create_vector.cc
125 encumbered/cpu/full/cv_spec_state.cc
126 encumbered/cpu/full/dd_queue.cc
127 encumbered/cpu/full/dep_link.cc
128 encumbered/cpu/full/dispatch.cc
129 encumbered/cpu/full/dyn_inst.cc
130 encumbered/cpu/full/execute.cc
131 encumbered/cpu/full/fetch.cc
132 encumbered/cpu/full/floss_reasons.cc
133 encumbered/cpu/full/fu_pool.cc
134 encumbered/cpu/full/inst_fifo.cc
135 encumbered/cpu/full/instpipe.cc
136 encumbered/cpu/full/issue.cc
137 encumbered/cpu/full/ls_queue.cc
138 encumbered/cpu/full/machine_queue.cc
139 encumbered/cpu/full/pipetrace.cc
140 encumbered/cpu/full/readyq.cc
141 encumbered/cpu/full/reg_info.cc
142 encumbered/cpu/full/rob_station.cc
143 encumbered/cpu/full/spec_memory.cc
144 encumbered/cpu/full/spec_state.cc
145 encumbered/cpu/full/storebuffer.cc
146 encumbered/cpu/full/writeback.cc
147 encumbered/cpu/full/iq/iq_station.cc
148 encumbered/cpu/full/iq/iqueue.cc
149 encumbered/cpu/full/iq/segmented/chain_info.cc
150 encumbered/cpu/full/iq/segmented/chain_wire.cc
151 encumbered/cpu/full/iq/segmented/iq_seg.cc
152 encumbered/cpu/full/iq/segmented/iq_segmented.cc
153 encumbered/cpu/full/iq/segmented/seg_chain.cc
154 encumbered/cpu/full/iq/seznec/iq_seznec.cc
155 encumbered/cpu/full/iq/standard/iq_standard.cc
156 encumbered/mem/functional/main.cc
164 mem/memory_interface.cc
165 mem/bus/base_interface.cc
167 mem/bus/bus_bridge.cc
168 mem/bus/bus_bridge_master.cc
169 mem/bus/bus_bridge_slave.cc
170 mem/bus/bus_interface.cc
171 mem/bus/dma_bus_interface.cc
172 mem/bus/dma_interface.cc
173 mem/bus/master_interface.cc
174 mem/bus/slave_interface.cc
175 mem/cache/base_cache.cc
177 mem/cache/cache_builder.cc
178 mem/cache/coherence/coherence_protocol.cc
179 mem/cache/coherence/uni_coherence.cc
180 mem/cache/miss/blocking_buffer.cc
181 mem/cache/miss/miss_queue.cc
182 mem/cache/miss/mshr.cc
183 mem/cache/miss/mshr_queue.cc
184 mem/cache/prefetch/base_prefetcher.cc
185 mem/cache/prefetch/prefetcher.cc
186 mem/cache/prefetch/tagged_prefetcher.cc
187 mem/cache/tags/base_tags.cc
188 mem/cache/tags/cache_tags.cc
189 mem/cache/tags/fa_lru.cc
190 mem/cache/tags/iic.cc
191 mem/cache/tags/lru.cc
192 mem/cache/tags/repl/gen.cc
193 mem/cache/tags/repl/repl.cc
194 mem/cache/tags/split.cc
195 mem/cache/tags/split_lru.cc
196 mem/cache/tags/split_lifo.cc
197 mem/functional/functional.cc
198 mem/timing/base_memory.cc
199 mem/timing/memory_builder.cc
200 mem/timing/simple_mem_bank.cc
201 mem/trace/itx_writer.cc
202 mem/trace/mem_trace_writer.cc
203 mem/trace/m5_writer.cc
206 python/embedded_py.cc
228 mysql_sources = Split('''
233 # Full-system sources
234 full_system_sources = Split('''
271 kern/kernel_binning.cc
273 kern/system_events.cc
274 kern/freebsd/freebsd_system.cc
275 kern/linux/linux_syscalls.cc
276 kern/linux/linux_system.cc
278 kern/tru64/dump_mbuf.cc
280 kern/tru64/tru64_events.cc
281 kern/tru64/tru64_syscalls.cc
282 kern/tru64/tru64_system.cc
284 mem/functional/memory_control.cc
285 mem/functional/physical.cc
291 # turbolaser encumbered sources
292 turbolaser_sources = Split('''
293 encumbered/dev/dma.cc
294 encumbered/dev/etherdev.cc
295 encumbered/dev/scsi.cc
296 encumbered/dev/scsi_ctrl.cc
297 encumbered/dev/scsi_disk.cc
298 encumbered/dev/scsi_none.cc
299 encumbered/dev/tlaser_clock.cc
300 encumbered/dev/tlaser_ipi.cc
301 encumbered/dev/tlaser_mbox.cc
302 encumbered/dev/tlaser_mc146818.cc
303 encumbered/dev/tlaser_node.cc
304 encumbered/dev/tlaser_pcia.cc
305 encumbered/dev/tlaser_pcidev.cc
306 encumbered/dev/tlaser_serial.cc
307 encumbered/dev/turbolaser.cc
308 encumbered/dev/uart8530.cc
311 # Syscall emulation (non-full-system) sources
312 syscall_emulation_sources = Split('''
313 cpu/memtest/memtest.cc
314 encumbered/eio/eio.cc
315 encumbered/eio/exolex.cc
316 encumbered/eio/libexo.cc
323 targetarch_files = Split('''
324 alpha_linux_process.hh
326 alpha_tru64_process.hh
336 # Set up bridging headers to the architecture specific versions
337 for f in targetarch_files:
338 env.Command('targetarch/' + f, 'arch/%s/%s' % (env['TARGET_ISA'], f),
339 '''echo '#include "arch/%s/%s"' > $TARGET''' % (env['TARGET_ISA'], f))
341 # Let the target architecture define what sources it needs
342 arch_source = SConscript('arch/%s/SConscript' % env['TARGET_ISA'],
343 build_dir = 'build/%s/' % env['BUILD_DIR'],
344 exports = 'env', duplicate = False)
346 # Add a flag defining what THE_ISA should be for all compilation
347 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
349 SConscript('arch/SConscript', exports = 'env', duplicate = False)
351 # Set up complete list of sources based on configuration.
352 sources = base_sources + arch_source
354 if env['FULL_SYSTEM']:
355 sources += full_system_sources
356 if env['ALPHA_TLASER']:
357 sources += turbolaser_sources
359 sources += syscall_emulation_sources
362 sources += mysql_sources
364 for opt in env.ExportOptions:
367 ###################################################
369 # Add an SCons scanner for ISA files
371 ###################################################
375 return SCons.Scanner.Classic("ISAScan",
378 '^[ \t]*##[ \t]*include[ \t]*"([^>"]+)"')
380 def ISAPath(env, dir, target=None, source=None, a=None):
381 return (Dir(env['SRCDIR']), Dir('.'))
383 iscan = Scanner(function = ISAScan().scan, skeys = [".isa", ".ISA"],
384 path_function = ISAPath)
385 env.Append(SCANNERS = iscan)
388 ###################################################
390 # Special build rules.
392 ###################################################
394 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
395 # $TARGET.base will expand to "<build-dir>/base/traceflags".
396 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
397 'base/traceflags.py',
398 'python $SOURCE $TARGET.base')
400 # several files are generated from arch/$TARGET_ISA/isa_desc.
401 env.Command(Split('''
404 arch/%s/alpha_o3_exec.cc
405 arch/%s/fast_cpu_exec.cc
406 arch/%s/simple_cpu_exec.cc
407 arch/%s/full_cpu_exec.cc''' %
416 arch/isa_parser.py''' %
418 '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/%s' % env['TARGET_ISA'])
421 # libelf build is described in its own SConscript file.
422 # SConscript-local is the per-config build, which just copies some
423 # header files into a place where they can be found.
424 SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
425 SConscript('python/SConscript', exports = ['env'], duplicate=0)
427 # This function adds the specified sources to the given build
428 # environment, and returns a list of all the corresponding SCons
429 # Object nodes (including an extra one for date.cc). We explicitly
430 # add the Object nodes so we can set up special dependencies for
432 def make_objs(sources, env):
433 objs = [env.Object(s) for s in sources]
434 # make date.cc depend on all other objects so it always gets
435 # recompiled whenever anything else does
436 date_obj = env.Object('base/date.cc')
437 env.Depends(date_obj, objs)
438 objs.append(date_obj)
441 ###################################################
443 # Define binaries. Each different build type (debug, opt, etc.) gets
444 # a slightly different build environment.
446 ###################################################
448 # Include file paths are rooted in this directory. SCons will
449 # automatically expand '.' to refer to both the source directory and
450 # the corresponding build directory to pick up generated include
452 env.Append(CPPPATH='.')
455 debugEnv = env.Copy(OBJSUFFIX='.do')
456 debugEnv.Label = 'debug'
457 debugEnv.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
458 debugEnv.Append(CPPDEFINES='DEBUG')
459 tlist = debugEnv.Program(target = 'm5.debug',
460 source = make_objs(sources, debugEnv))
461 debugEnv.M5Binary = tlist[0]
466 optEnv.Append(CCFLAGS=Split('-g -O5'))
467 tlist = optEnv.Program(target = 'm5.opt',
468 source = make_objs(sources, optEnv))
469 optEnv.M5Binary = tlist[0]
472 fastEnv = env.Copy(OBJSUFFIX='.fo')
473 fastEnv.Label = 'fast'
474 fastEnv.Append(CCFLAGS=Split('-O5'))
475 fastEnv.Append(CPPDEFINES='NDEBUG')
476 fastEnv.Program(target = 'm5.fast.unstripped',
477 source = make_objs(sources, fastEnv))
478 tlist = fastEnv.Command(target = 'm5.fast',
479 source = 'm5.fast.unstripped',
480 action = 'strip $SOURCE -o $TARGET')
481 fastEnv.M5Binary = tlist[0]
484 profEnv = env.Copy(OBJSUFFIX='.po')
485 profEnv.Label = 'prof'
486 profEnv.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
487 tlist = profEnv.Program(target = 'm5.prof',
488 source = make_objs(sources, profEnv))
489 profEnv.M5Binary = tlist[0]
491 envList = [debugEnv, optEnv, fastEnv, profEnv]