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
226 # These are now included by the architecture specific SConscript
227 # arch/alpha/decoder.cc
228 # arch/alpha/alpha_o3_exec.cc
229 # arch/alpha/fast_cpu_exec.cc
230 # arch/alpha/simple_cpu_exec.cc
231 # arch/alpha/full_cpu_exec.cc
232 # arch/alpha/faults.cc
233 # arch/alpha/isa_traits.cc
236 mysql_sources = Split('''
241 # Full-system sources
242 full_system_sources = Split('''
279 kern/kernel_binning.cc
281 kern/system_events.cc
282 kern/freebsd/freebsd_system.cc
283 kern/linux/linux_syscalls.cc
284 kern/linux/linux_system.cc
286 kern/tru64/dump_mbuf.cc
288 kern/tru64/tru64_events.cc
289 kern/tru64/tru64_syscalls.cc
290 kern/tru64/tru64_system.cc
292 mem/functional/memory_control.cc
293 mem/functional/physical.cc
299 # These are now included by the architecture specific SConscript
300 # arch/alpha/alpha_memory.cc
301 # arch/alpha/arguments.cc
303 # arch/alpha/osfpal.cc
304 # arch/alpha/pseudo_inst.cc
305 # arch/alpha/stacktrace.cc
306 # arch/alpha/vtophys.cc
308 # turbolaser encumbered sources
309 turbolaser_sources = Split('''
310 encumbered/dev/dma.cc
311 encumbered/dev/etherdev.cc
312 encumbered/dev/scsi.cc
313 encumbered/dev/scsi_ctrl.cc
314 encumbered/dev/scsi_disk.cc
315 encumbered/dev/scsi_none.cc
316 encumbered/dev/tlaser_clock.cc
317 encumbered/dev/tlaser_ipi.cc
318 encumbered/dev/tlaser_mbox.cc
319 encumbered/dev/tlaser_mc146818.cc
320 encumbered/dev/tlaser_node.cc
321 encumbered/dev/tlaser_pcia.cc
322 encumbered/dev/tlaser_pcidev.cc
323 encumbered/dev/tlaser_serial.cc
324 encumbered/dev/turbolaser.cc
325 encumbered/dev/uart8530.cc
328 # Syscall emulation (non-full-system) sources
329 syscall_emulation_sources = Split('''
330 cpu/memtest/memtest.cc
331 encumbered/eio/eio.cc
332 encumbered/eio/exolex.cc
333 encumbered/eio/libexo.cc
338 # These are now included by the architecture specific SConscript
339 # arch/alpha/alpha_common_syscall_emul.cc
340 # arch/alpha/alpha_linux_process.cc
341 # arch/alpha/alpha_tru64_process.cc
343 targetarch_files = Split('''
344 alpha_linux_process.hh
346 alpha_tru64_process.hh
359 # alpha_common_syscall_emul.hh
361 # isa_fullsys_traits.hh
363 # Set up bridging headers to the architecture specific versions
364 for f in targetarch_files:
365 env.Command('targetarch/' + f, 'arch/%s/%s' % (env['TARGET_ISA'], f),
366 '''echo '#include "arch/%s/%s"' > $TARGET''' % (env['TARGET_ISA'], f))
368 # Let the target architecture define what sources it needs
369 arch_source = SConscript('arch/%s/SConscript' % env['TARGET_ISA'],
370 build_dir = 'build/%s/' % env['BUILD_DIR'],
371 exports = 'env', duplicate = False)
373 # Add a flag defining what THE_ISA should be for all compilation
374 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
376 # Set up complete list of sources based on configuration.
377 sources = base_sources + arch_source
379 if env['FULL_SYSTEM']:
380 sources += full_system_sources
381 if env['ALPHA_TLASER']:
382 sources += turbolaser_sources
384 sources += syscall_emulation_sources
387 sources += mysql_sources
389 for opt in env.ExportOptions:
392 ###################################################
394 # Add an SCons scanner for ISA files
396 ###################################################
400 return SCons.Scanner.Classic("ISAScan",
403 '^[ \t]*##[ \t]*include[ \t]*"([^>"]+)"')
405 def ISAPath(env, dir, target=None, source=None, a=None):
406 return (Dir(env['SRCDIR']), Dir('.'))
408 iscan = Scanner(function = ISAScan().scan, skeys = [".isa", ".ISA"],
409 path_function = ISAPath)
410 env.Append(SCANNERS = iscan)
413 ###################################################
415 # Special build rules.
417 ###################################################
419 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
420 # $TARGET.base will expand to "<build-dir>/base/traceflags".
421 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
422 'base/traceflags.py',
423 'python $SOURCE $TARGET.base')
425 # several files are generated from arch/$TARGET_ISA/isa_desc.
426 env.Command(Split('''
429 arch/%s/alpha_o3_exec.cc
430 arch/%s/fast_cpu_exec.cc
431 arch/%s/simple_cpu_exec.cc
432 arch/%s/full_cpu_exec.cc''' %
441 arch/isa_parser.py''' %
443 '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/%s' % env['TARGET_ISA'])
446 # libelf build is described in its own SConscript file.
447 # SConscript-local is the per-config build, which just copies some
448 # header files into a place where they can be found.
449 SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
450 SConscript('python/SConscript', exports = ['env'], duplicate=0)
452 # This function adds the specified sources to the given build
453 # environment, and returns a list of all the corresponding SCons
454 # Object nodes (including an extra one for date.cc). We explicitly
455 # add the Object nodes so we can set up special dependencies for
457 def make_objs(sources, env):
458 objs = [env.Object(s) for s in sources]
459 # make date.cc depend on all other objects so it always gets
460 # recompiled whenever anything else does
461 date_obj = env.Object('base/date.cc')
462 env.Depends(date_obj, objs)
463 objs.append(date_obj)
466 ###################################################
468 # Define binaries. Each different build type (debug, opt, etc.) gets
469 # a slightly different build environment.
471 ###################################################
473 # Include file paths are rooted in this directory. SCons will
474 # automatically expand '.' to refer to both the source directory and
475 # the corresponding build directory to pick up generated include
477 env.Append(CPPPATH='.')
480 debugEnv = env.Copy(OBJSUFFIX='.do')
481 debugEnv.Label = 'debug'
482 debugEnv.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
483 debugEnv.Append(CPPDEFINES='DEBUG')
484 tlist = debugEnv.Program(target = 'm5.debug',
485 source = make_objs(sources, debugEnv))
486 debugEnv.M5Binary = tlist[0]
491 optEnv.Append(CCFLAGS=Split('-g -O5'))
492 tlist = optEnv.Program(target = 'm5.opt',
493 source = make_objs(sources, optEnv))
494 optEnv.M5Binary = tlist[0]
497 fastEnv = env.Copy(OBJSUFFIX='.fo')
498 fastEnv.Label = 'fast'
499 fastEnv.Append(CCFLAGS=Split('-O5'))
500 fastEnv.Append(CPPDEFINES='NDEBUG')
501 fastEnv.Program(target = 'm5.fast.unstripped',
502 source = make_objs(sources, fastEnv))
503 tlist = fastEnv.Command(target = 'm5.fast',
504 source = 'm5.fast.unstripped',
505 action = 'strip $SOURCE -o $TARGET')
506 fastEnv.M5Binary = tlist[0]
509 profEnv = env.Copy(OBJSUFFIX='.po')
510 profEnv.Label = 'prof'
511 profEnv.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
512 tlist = profEnv.Program(target = 'm5.prof',
513 source = make_objs(sources, profEnv))
514 profEnv.M5Binary = tlist[0]
516 envList = [debugEnv, optEnv, fastEnv, profEnv]